Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(plugin-holdstation): add plugin holdstation swap #2596

Merged
merged 2 commits into from
Jan 21, 2025

Conversation

cuongnguyenthai
Copy link
Contributor

@cuongnguyenthai cuongnguyenthai commented Jan 21, 2025

Relates to

No specific issue or ticket is linked to this PR.

Risks

Low: This PR is for create a plugin that is not effecting the core functionality of the application.

Background

What does this PR do?

This PR creates a plugin that allows users integrate with Holdstation Wallet on now on Zksync Era and Berachain coming soon. including the following features:

  • Token swapping on Hold.so (Holdstation swap)

What kind of change is this?

Features (non-breaking change which adds functionality)

Documentation changes needed?

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

Testing

Where should a reviewer start?

Review the new plugin from src/index.ts, actions/_ providers/_

Detailed testing steps

Please refer to the README.md for detailed testing steps.

Summary by CodeRabbit

Release Notes for HoldStation Wallet Plugin

  • New Features

    • Added HoldStation Wallet Plugin for token swapping
    • Supports ZKsync Era blockchain
    • Enables token allowance and transaction approvals
  • Configuration

    • Introduced HOLDSTATION_PRIVATE_KEY environment variable for wallet setup
  • Plugin Capabilities

    • Fetch wallet portfolio
    • Swap tokens
    • Check token allowances
  • Compatibility

    • Integrates with Eliza agent framework
    • Requires private key configuration

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @cuongnguyenthai! 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!

@wtfsayo wtfsayo enabled auto-merge (squash) January 21, 2025 10:06
@wtfsayo wtfsayo self-requested a review January 21, 2025 10:06
@wtfsayo wtfsayo merged commit 701f32e into elizaOS:develop Jan 21, 2025
5 of 7 checks passed
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Caution

Review failed

The head commit changed during the review from ee25eee to eabc0dc.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

agent/src/index.ts

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.


🪧 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.

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

agent/src/index.ts

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

This pull request introduces the HoldStation Wallet Plugin for the Eliza framework, adding a comprehensive set of functionalities for token swapping and wallet interactions. The changes include creating a new plugin package with configuration options, environment validation, wallet provider, swap actions, and supporting utilities for blockchain interactions, specifically targeting ZKsync Era.

Changes

File Change Summary
.env.example Added HOLDSTATION_PRIVATE_KEY configuration
agent/package.json Added @elizaos/plugin-holdstation dependency
agent/src/index.ts Conditionally integrated HoldStation plugin
packages/plugin-holdstation/* New plugin package with comprehensive implementation

Possibly related PRs

Suggested Labels

plugin_new


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c55de24 and eabc0dc.

📒 Files selected for processing (20)
  • .env.example (1 hunks)
  • agent/package.json (1 hunks)
  • agent/src/index.ts (2 hunks)
  • packages/plugin-holdstation/.npmignore (1 hunks)
  • packages/plugin-holdstation/README.md (1 hunks)
  • packages/plugin-holdstation/eslint.config.mjs (1 hunks)
  • packages/plugin-holdstation/package.json (1 hunks)
  • packages/plugin-holdstation/src/actions/swapAction.ts (1 hunks)
  • packages/plugin-holdstation/src/constants/index.ts (1 hunks)
  • packages/plugin-holdstation/src/environment.ts (1 hunks)
  • packages/plugin-holdstation/src/hooks/index.ts (1 hunks)
  • packages/plugin-holdstation/src/hooks/useGetAccount.ts (1 hunks)
  • packages/plugin-holdstation/src/hooks/useGetWalletClient.ts (1 hunks)
  • packages/plugin-holdstation/src/index.ts (1 hunks)
  • packages/plugin-holdstation/src/providers/walletProvider.ts (1 hunks)
  • packages/plugin-holdstation/src/templates/index.ts (1 hunks)
  • packages/plugin-holdstation/src/templates/swapTemplate.ts (1 hunks)
  • packages/plugin-holdstation/src/types/index.ts (1 hunks)
  • packages/plugin-holdstation/tsconfig.json (1 hunks)
  • packages/plugin-holdstation/tsup.config.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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.

0xrubusdata pushed a commit to 0xrubusdata/eliza that referenced this pull request Jan 21, 2025
Co-authored-by: CuongNT <cuongnt@holdstation.com>
Co-authored-by: Sayo <hi@sayo.wtf>
@wtfsayo
Copy link
Member

wtfsayo commented Jan 22, 2025

This plugin was reverted; because of build issues; can you open new PR where it passes integrationTests; you can connect with me on discord if any issues! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants