feat: NEAR Protocol Intents
Background
This PR implements cross-chain token swapping functionality using the NEAR Intents, allowing users to swap tokens between NEAR and other supported chains.
What does this PR do?
- Implements cross-chain token swapping functionality
- Adds token configuration management
- Implements deposit and withdrawal functionality
- Adds support for multiple chains and tokens
- Implements intent message signing and publishing
Current limitations: This PR only allows deposits from NEAR into the NEAR Intents protocol but allows for swapping and withdrawing to any supported chain.
What kind of change is this?
Features: Cross-chain Swap Bug fixes: Fixes the NEAR swap Ref.finance problems
Risks
- High: With the
withdraw_cross_chain_swap_nearfunction called, the resulting swap can be moved to an address provided to the agent. - Medium: Transaction failures during cross-chain operations
- Medium: Price slippage during swaps
- Low: Token configuration updates needed for new assets
- Low: Storage balance requirements for new users
Why are we doing this? Any context or related work?
Near Protocol introduced Near Intents which allows for cross-chain swaps between supported chains. This tool is great for eliza agents since they have wallets on many different protocols. They can leverage this change in the plugin to swap their assets in different chains.
Documentation changes needed?
Updated README.md already with necessary changes.
Where should a reviewer start?
Start up eliza with near-plugin enabled and .env properties provided, ask it to swap the asset that you have on NEAR to swap with an asset on another chain ("swap it to USDC on Base") with an address (0x).
If you are stuck and things are not moving, go to the website https://app.near-intents.org/ and see if you are missing required assets.
@coderabbitai review
📝 Walkthrough
Walkthrough
The pull request introduces comprehensive cross-chain functionality for the NEAR Protocol plugin, expanding its capabilities to support token swaps, deposits, and withdrawals across multiple blockchain networks. The changes include new actions, type definitions, utility functions, and configuration files that enable seamless cross-chain operations using Near Intents, with enhanced support for unified tokens and cross-chain transaction management.
Changes
| File | Change Summary |
|---|---|
README.md |
Added cross-chain functionality descriptions, new usage examples, and updated API references for cross-chain swap actions |
package.json |
Added dependencies like viem, borsh, zod to support cross-chain operations |
src/actions/crossChainSwap.ts |
New module for handling cross-chain swaps, including RPC requests, quote management, and swap/withdrawal logic |
src/config/tokens.json |
New token configuration defining unified and single-chain tokens across multiple networks |
src/index.ts |
Added executeCrossChainSwap and executeCrossChainSwapAndWithdraw actions |
src/types/* |
New type definitions for intents, tokens, deposits, supporting cross-chain functionality |
tsconfig.json |
Updated compiler options to enable decorators and JSON module imports |
Finishing Touches
- [ ] 📝 Generate Docstrings (Beta)
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Hello,
We are changing our plugin development strategy to be more scalable. We have moved the plugins out into their own repos and we're looking for people to either maintain those or own them on their own Github.
Please make your code changes to this repo: https://github.com/elizaos-plugins/plugin-near
If you'd like to be a maintainer, file an issue in the plugin repo and join our Discord https://discord.gg/elizaos to coordinate.
If you'd like to control the plugin on your own Github, please add an issue to the plugin repo pointing to your repo, and add a modification to the registry. Submit a PR to edit the registry here: https://github.com/elizaos-plugins/registry
Closing this PR for now. Let us know if you have any questions