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: Add plugin-ethstorage #2737

Merged
merged 1 commit into from
Jan 24, 2025
Merged

feat: Add plugin-ethstorage #2737

merged 1 commit into from
Jan 24, 2025

Conversation

iteyelmp
Copy link
Contributor

Relates to

The PR is not related to any issues.

Risks

Low risk, this PR is to add a new plugin, does not affect the core functionalities of Eliza.

Background

There are existing tools that assist users in interacting with decentralized storage networks like EthStorage. These tools enable users to store and retrieve data in a decentralized manner, leveraging blockchain-based storage mechanisms. The EthStorage plugin allows for the transfer of QKC tokens and submission of arbitrary data to the EthStorage network, offering users a way to interact with decentralized storage easily. The plugin also provides a simple interface to interact with the EthStorage testnet and, once the mainnet is available, will enable mainnet interactions.

What does this PR do?

This PR adds the plugin-ethstorage, which interacts with the EthStorage decentralized storage network. The plugin supports two primary actions: transferring QKC tokens and submitting data to the EthStorage network. It is designed to work with the testnet, and the configuration can be customized via environment variables.

What kind of change is this?

Features

Documentation changes needed?

No changes required for Eliza's documentation. The plugin-ethstorage documentation has been updated to reflect its functionality.

Testing

Where should a reviewer start?

Reviewers should integrate the plugin into a local agent and ensure the .env file is properly configured with ETHSTORAGE_ADDRESS (default set to the testnet), ETHSTORAGE_PRIVATE_KEY, and ETHSTORAGE_RPC_URL (a default value is provided, but you can modify it if needed).

Detailed testing steps

  1. Ensure the .env file is configured with ETHSTORAGE_ADDRESS, ETHSTORAGE_PRIVATE_KEY, and ETHSTORAGE_RPC_URL. The ETHSTORAGE_ADDRESS is set to the default testnet value, and ETHSTORAGE_RPC_URL has a default value as well, but both can be changed if needed.
  2. Test the transfer function by running: send <AMOUNT> QKC to <any other EthStorage account>.
  3. Test the data submission functionality by running: Submit the following data using the key <KEY> to EthStorage <DATA>.
  4. Verify that both actions are successfully executed by checking the transaction hash on the EthStorage testnet explorer.

Screenshots

Deploy Notes

Please ensure that the ETHSTORAGE_ADDRESS, ETHSTORAGE_RPC_URL and ETHSTORAGE_PRIVATE_KEY are correctly configured before deploying the plugin.

Database changes

No database changes.

Deployment instructions

No additional deployment steps required other than configuring the environment variables.

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

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

@wtfsayo wtfsayo self-requested a review January 24, 2025 07:43
@wtfsayo wtfsayo enabled auto-merge January 24, 2025 07:55
@wtfsayo wtfsayo added this pull request to the merge queue Jan 24, 2025
@wtfsayo wtfsayo removed this pull request from the merge queue due to a manual request Jan 24, 2025
@wtfsayo wtfsayo added this pull request to the merge queue Jan 24, 2025
@wtfsayo wtfsayo removed this pull request from the merge queue due to a manual request Jan 24, 2025
@wtfsayo
Copy link
Member

wtfsayo commented Jan 24, 2025

Screenshot 2025-01-24 at 10 32 27 pm

@shakkernerd shakkernerd merged commit 93f1553 into elizaOS:develop Jan 24, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants