Teach Zilliqa plugin about PlunderSwap currency exchange.

[mtbc]

Relates to

No issue or ticket.

Risks

Simply adds more actions to the Zilliqa plugin.
Introduces a dependency on the GOAT plunderswap plugin.

Worst risk is that somehow the LLM mangles data so that the user swaps the wrong amount of the wrong currency. However, the GOAT plugin is written to deposit always back into the same wallet so, at worst, the user just has to swap to what they wanted originally.

Background

What does this PR do?

Adds actions to ZIlliqa plugin, under the auspices of a related plugin class ZilliqaEvmPlugin, that allow Eliza to drive GOAT's plugin for PlunderSwap.

What kind of change is this?

Features (non-breaking change which adds functionality)

Why are we doing this? Any context or related work?

This allows users to do currency exchanges using PlunderSwap's V2 liquidity pool on Zilliqa's chain.

It includes actions for converting Zilliqa's native ZIL token to WZIL (wrapped ZIL) which also has liquidity in the pool, and for converting it back to native ZIL, enabling a user to start with ZIL and end up with anything available in the token reserves.

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Detailed testing steps

Populate ZILLIQA_PRIVATE_KEY in the environment. If you invent some new key for an EVM wallet, you can get some native ZIL for it from https://dev-wallet.zilliqa.com/faucet?network=testnet.

Set ZILLIQA_PROVIDER_URL to https://api.testnet.zilliqa.com

See the screenshots for the kinds of interaction one can do. Probably start by wrapping most but not all ZIL that the faucet gave you:

• you need some left over for gas for transactions
• the rest becomes WZIL that you can try swapping for other tokens. liquidity permitting.

Whenever you do transactions whose hashes are reported, you can see them in the block explorer by postfixing https://otterscan.testnet.zilliqa.com/tx/ with the hash.

Screenshots

After

Deploy Notes

Deployment instructions

See notes above about ZILLIQA_PRIVATE_KEY and ZILLIQA_PROVIDER_URL .

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.

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.

[github-actions]

Hi @mtbc! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!

[odilitime]

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-zilliqa

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.

[mtbc]

Thanks @odilitime, I'll look to do that. From the point of view of developing against https://github.com/elizaos-plugins/plugin-zilliqa, what to do about it claiming,

"@elizaos/core": "workspace:*"

when it's not in the workspace any more? I don't see git submodules being used anywhere. Are there some tips for setting things up locally so that I can build the plugin and run it with an agent?