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 lit plugin #2703

Merged
merged 8 commits into from
Jan 24, 2025
Merged

feat: add lit plugin #2703

merged 8 commits into from
Jan 24, 2025

Conversation

dezcalimese
Copy link
Contributor

Relates to

Lit Protocol Integration for ElizaOS

Risks

Medium

  • Handles cryptocurrency transactions and wallet management
  • Manages private keys and sensitive configuration data
  • Interacts with blockchain networks

Background

What does this PR do?

Introduces the @elizaos/plugin-lit package, which provides comprehensive blockchain interaction capabilities powered by Lit Protocol's Programmable Key Pairs (PKPs). The plugin enables:

  1. Dual-chain wallet management (EVM + Solana)
  2. Secure transaction signing and execution
  3. Automated PKP lifecycle management
  4. Capacity credit management for rate limiting
  5. Transaction security validations

What kind of change is this?

Features (non-breaking change which adds functionality)

Documentation changes needed?

Documentation has been provided in the form of:

  • README.md with comprehensive usage instructions
  • PKP setup guide (pkp-setup.md)
  • Code documentation and type definitions

Testing

Where should a reviewer start?

  1. Review the main plugin entry point: src/index.ts
  2. Examine the core actions:
  • sendEth.ts
  • sendSol.ts
  • sendUSDC.ts
  1. Check the Lit Provider implementation: src/providers/litProvider.ts

Detailed testing steps

  1. Install the package
pnpm add @elizaos/plugin-lit
  1. Configure environment variables
FUNDING_PRIVATE_KEY=   # Private key for funding operations
EVM_RPC_URL=          # RPC endpoint for blockchain interactions
LIT_PKP_PUBLIC_KEY=   # (Optional) Existing PKP public key
  1. Test basic functionality
import { litPlugin } from '@elizaos/plugin-lit';

// Register plugin
runtime.registerPlugin(litPlugin);

// Test ETH transfer
await runtime.executeAction('SEND_ETH', {
  text: "Send 0.01 ETH to 0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
});

The plugin requires proper configuration of:

  • lit-config.json (automatically generated)
  • Environment variables
  • Network RPC endpoints

None - Configuration is file-based using lit-config.json

  1. Ensure proper environment variables are set
  2. Deploy with proper security measures for lit-config.json
  3. Monitor initial PKP creation and capacity credit allocation
  4. Verify wallet funding for transaction execution

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.


🪧 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

@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 @dezcalimese! 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 January 24, 2025 12:49
@wtfsayo wtfsayo disabled auto-merge January 24, 2025 12:49
@wtfsayo wtfsayo self-requested a review January 24, 2025 12:49
@wtfsayo wtfsayo enabled auto-merge (squash) January 24, 2025 16:46
@wtfsayo wtfsayo merged commit bc0ed87 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants