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(new-plugin): add shogun sdk plugin #2706

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

dezcalimese
Copy link
Contributor

Relates to

Integration of Lit Protocol and Shogun SDK plugins into the ElizaOS ecosystem

Risks

Medium

  • Both plugins handle cryptocurrency transactions and sensitive operations
  • Risks include:
    • Transaction security and validation
    • Private key management through PKPs
    • Cross-chain bridge security
    • Smart contract interactions
    • Rate limiting and capacity management

Background

What does this PR do?

Introduces two core plugins for ElizaOS:

  1. @elizaos/plugin-lit:
  • Implements secure blockchain transaction capabilities
  • Manages PKP lifecycle and wallet operations
  • Handles multi-chain (EVM + Solana) transactions
  • Manages capacity credits and session authentication
  1. @elizaos/plugin-shogun:
  • Provides DeFi functionality through Shogun SDK
  • Implements cross-chain token swaps
  • Handles price quotes and slippage protection
  • Integrates with multiple DEX aggregators

What kind of change is this?

Features (non-breaking change which adds functionality)

Documentation changes needed?

Yes, documentation changes are required:

  • API documentation for both plugins
  • Integration guides
  • Configuration documentation
  • Security best practices
  • Example usage scenarios

Testing

Where should a reviewer start?

  1. Review core plugin files:
@plugin-lit/src/
  ├── index.ts
  ├── actions/
  │   ├── sendEth.ts
  │   ├── sendSol.ts
  │   └── sendUSDC.ts
  └── providers/
      └── litProvider.ts

@plugin-shogun/src/
  ├── index.ts
  └── actions/
      ├── evmQuote.ts
      └── evmSwap.ts

Detailed testing steps

  1. Setup environment
# Install dependencies
npm install @elizaos/plugin-lit @elizaos/plugin-shogun

# Configure environment variables
export LIT_PKP_PUBLIC_KEY="your_pkp_key"
export EVM_RPC_URL="your_rpc_url"
  1. Test Lit Plugin
// Test ETH transfer
await runtime.executeAction('SEND_ETH', {
  amount: "0.01",
  recipient: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
});
  1. Test Shogun Plugin
// Test token swap quote
await runtime.executeAction('EVM_QUOTE', {
  fromToken: "ETH",
  toToken: "USDC",
  amount: "0.1"
});
  1. Verify:
  • Transaction success
  • Gas optimization
  • Error handling
  • Security validations

None - Configuration is file-based

  1. Configure environment variables
  2. Deploy PKP infrastructure
  3. Setup capacity credit system
  4. Configure RPC endpoints
  5. Deploy plugins
  6. Monitor initial transactions
  7. Verify security measures
    Both plugins require careful deployment with proper security measures and monitoring in place.

Copy link
Contributor

coderabbitai bot commented Jan 23, 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 changed the title feat: add lit and shogun plugins feat(new-plugin): add shogun sdk plugin Jan 25, 2025
@wtfsayo
Copy link
Member

wtfsayo commented Jan 25, 2025

I dont understand why you're putting @shogun/sdk here instead of npm imports; very confusing; please send cleaner PR

@wtfsayo wtfsayo self-requested a review January 25, 2025 05:46
Copy link
Member

@wtfsayo wtfsayo left a comment

Choose a reason for hiding this comment

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

plz send cleaner PR and stick to convention

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.

2 participants