search

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

feat: added ability to swap token on and from ZetaChain #186

Closed fadeev closed 3 months ago

fadeev commented 4 months ago

Extracting the swap logic into a separate function makes it easy to add a set of additional swap features:

Summary by CodeRabbit

fadeev commented 4 months ago

@andresaiello please, review.

fadeev commented 4 months ago

@andresaiello please, review.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates enhance token swapping functionality in the Swap and SwapToAnyToken smart contracts. Key changes include parameter updates for swapAndWithdraw, new internal and public swap functions, and a receive() function to handle payable transactions. The new Hardhat task script swap.ts facilitates token swaps by interacting with the Swap contract on ZetaChain, validating parameters, and managing token approvals and transfers.

Changes

File Change Summary
.../Swap.sol Updated swapAndWithdraw function to use targetToken parameter consistently and accept new parameters.
.../SwapToAnyToken.sol Added error TransferFailed() declaration; receive() function; refactored onCrossChainCall; introduced swap functions.
.../tasks/swap.ts Introduced a task for interacting with the Swap contract: validates parameters, manages token approvals, and facilitates swaps.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Hardhat
    participant SwapContract
    participant SwapToAnyTokenContract
    participant ERC20TokenContract

    User->>Hardhat: Initiate swap task
    Hardhat->>SwapContract: Validate parameters
    Hardhat->>ERC20TokenContract: Approve tokens
    ERC20TokenContract-->>Hardhat: Approval complete
    Hardhat->>SwapContract: Execute swapAndWithdraw
    SwapContract->>SwapToAnyTokenContract: Call swapAndWithdraw
    SwapToAnyTokenContract->>ERC20TokenContract: Perform swap
    ERC20TokenContract-->>SwapToAnyTokenContract: Swap complete
    SwapToAnyTokenContract-->>SwapContract: SwapAndWithdraw complete
    SwapContract-->>Hardhat: Swap task complete
    Hardhat-->>User: Swap successful

Poem

Across the chains, the tokens fly,
In contracts' code, they now comply.
With swaps anew and flows refined,
Transactions swift, no fees confined.
In Rabbit's world of tokens fair,
A dance of bytes, a seamless pair.
Swap and trade, with ease we share.

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 .` - `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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Drowzilla commented 1 month ago

So I have a stuck transaction where I sent zetachain from atomic wallet to Coinbase zetacha chain that is apparently not compatible, are those funds completely lost it's been a couple months now ?