zeta-chain / example-contracts

Examples of universal smart contract implementing cross-chain swaps, NFT transfers, ERC-20 transfers and more
https://www.zetachain.com/docs
MIT License
82 stars 47 forks source link

onlyGateway modifier #213

Closed fadeev closed 2 weeks ago

fadeev commented 2 weeks ago

To prevent malicious third-party contract from calling onCall and onRevert.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The pull request introduces a new modifier, `onlyGateway`, across multiple smart contracts, including `Echo`, `Hello`, `Connected`, `Universal`, `Swap`, and `SwapToAnyToken`. This modifier restricts access to specific functions, ensuring that only the designated gateway address can invoke them. The `onCall` and `onRevert` functions in each contract are updated to include this modifier, enhancing security by preventing unauthorized access. Additionally, the `test.sh` script is modified to include calls to the `nft_balance` function, improving visibility of NFT balances during execution. ## Changes | File Path | Change Summary | |------------------------------------------------|----------------------------------------------------------------------------------------------------| | examples/hello/contracts/Echo.sol | - Added modifier `onlyGateway()`
- Updated `onRevert` to `external onlyGateway` | | examples/hello/contracts/Hello.sol | - Added modifier `onlyGateway()`
- Updated `onCall` and `onRevert` to `external onlyGateway` | | examples/nft/contracts/Connected.sol | - Added modifier `onlyGateway()`
- Updated `onCall` and `onRevert` to `external onlyGateway` | | examples/nft/contracts/Universal.sol | - Added modifier `onlyGateway()`
- Updated `onCall` and `onRevert` to `external onlyGateway` | | examples/swap/contracts/Swap.sol | - Added modifier `onlyGateway()`
- Updated `onCall` and `onRevert` to `external onlyGateway` | | examples/swap/contracts/SwapToAnyToken.sol | - Added modifier `onlyGateway()`
- Updated `onCall` and `onRevert` to `external onlyGateway` | | examples/nft/scripts/test.sh | - Added function call `nft_balance()` at various points in the script | ## Possibly related PRs - **#186**: The `Swap` contract changes include the addition of the `onlyGateway` modifier, which is similar to the changes made in the `Echo` contract in the main PR, where the `onlyGateway` modifier was also introduced. - **#189**: The `Hello` contract in this PR also introduces the `onlyGateway` modifier and modifies the `onRevert` function, which aligns with the changes made in the `Echo` contract regarding access control. - **#192**: The `SwapToAnyToken` contract changes include the `onlyGateway` modifier, which is consistent with the access control changes made in the `Echo` contract. - **#198**: This PR modifies the `Swap` contract's approval logic, which could be related to the changes in access control and function signatures in the `Echo` contract. - **#200**: The addition of the `gatewayCall` function in the `Hello` contract demonstrates cross-chain functionality, which is relevant to the access control changes made in the `Echo` contract. - **#201**: The changes in the `Echo` contract, including the introduction of new functions and the renaming of the contract, are directly related to the modifications made in this PR, which focuses on enhancing contract functionality.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
fadeev commented 2 weeks ago

@coderabbitai review

coderabbitai[bot] commented 2 weeks ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.