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: draft geyser plugin support #33

Merged
merged 3 commits into from
Feb 12, 2025
Merged

Conversation

lgalabru
Copy link
Member

@lgalabru lgalabru commented Feb 11, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a command-line option for specifying plugin configuration files, enhancing plugin support and customization.
  • Chores

    • Upgraded dependency versions and toolchain configurations to boost compatibility and overall reliability.
  • Refactor

    • Streamlined transaction confirmation and error handling processes to provide clearer feedback during operations.

Copy link

coderabbitai bot commented Feb 11, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates the Rust toolchain version in both the GitHub workflow and the toolchain file, and bumps dependency versions in Cargo.toml files. It introduces a new plugin_config_path field to configuration structs in both CLI and core modules, along with updates to function signatures to pass configuration by value. Enhancements in error handling and control flow for transaction confirmation and plugin management are also implemented. Additionally, new Solana-related dependencies and plugin management integrations are added to the core package.

Changes

File(s) Change Summary
.github/workflows/release.yaml, rust-toolchain Updated Rust toolchain version (release.yaml: toolchain from 1.79 to 1.84.0; rust-toolchain: channel changed from 1.84.1 to 1.84.0).
crates/cli/Cargo.toml, crates/cli/src/cli/mod.rs Bumped dependency versions (txtx-core: 0.2.1→0.2.2, txtx-addon-network-svm: 0.1.2→0.1.3) and added a new optional field plugin_config_path to the StartSimnet struct.
crates/cli/src/cli/simnet/mod.rs Added plugin_config_path (Vec) to SurfpoolConfig, updated the simnet command to pass configuration by value, and improved keypair file error handling.
crates/core/Cargo.toml Removed the clap dependency, updated spl-token-2022 (4.0.0→6.0.0), and added multiple Solana-related dependencies along with new libraries for geyser plugin support.
crates/core/src/lib.rs Modified the start_simnet function signature to accept SurfpoolConfig by value instead of by reference.
crates/core/src/rpc/full.rs Changed the transaction confirmation loop to break on Confirmed regardless of commitment level and refined error handling in get_signature_statuses.
crates/core/src/simnet/mod.rs Integrated modules for geyser plugins, introduced a new plugin constructor type, revised the start function to take configuration by value, and added a thread to manage plugin communication with enhanced error handling.
crates/core/src/types.rs Updated the SurfpoolConfig struct by adding a plugin_config_path field and removing the Clone trait from its derives.

Sequence Diagram(s)

sequenceDiagram
    participant U as User/CLI
    participant SC as Simnet Command Handler
    participant CS as Core Simnet Module
    participant PM as Plugin Manager
    U->>SC: Execute StartSimnet (--geyser-plugin-config)
    SC->>CS: Pass SurfpoolConfig (by value)
    CS->>PM: Initialize plugin manager with plugin_config_path
    PM->>PM: Load and validate plugins
    CS->>PM: Send transaction metadata
    PM-->>CS: Return plugin confirmation/status
Loading

Possibly related PRs

Poem

Hopping through the code with glee,
A rabbit’s joy in every key.
Updated tools and plugins shine,
Configs and crates now align.
I nibble bugs and debug with art –
CodeRabbit hops with a happy heart!
🥕🐇


📜 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 7bc106f and 3d665ae.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (10)
  • .github/workflows/release.yaml (1 hunks)
  • crates/cli/Cargo.toml (1 hunks)
  • crates/cli/src/cli/mod.rs (1 hunks)
  • crates/cli/src/cli/simnet/mod.rs (2 hunks)
  • crates/core/Cargo.toml (2 hunks)
  • crates/core/src/lib.rs (1 hunks)
  • crates/core/src/rpc/full.rs (1 hunks)
  • crates/core/src/simnet/mod.rs (5 hunks)
  • crates/core/src/types.rs (2 hunks)
  • rust-toolchain (1 hunks)

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.

@lgalabru lgalabru force-pushed the feat/support-geyser-plugins branch 3 times, most recently from bba593f to e19f688 Compare February 12, 2025 02:14
@lgalabru lgalabru force-pushed the feat/support-geyser-plugins branch from e19f688 to 3d665ae Compare February 12, 2025 02:56
@lgalabru lgalabru marked this pull request as ready for review February 12, 2025 03:08
@lgalabru lgalabru merged commit 10523d6 into main Feb 12, 2025
2 of 3 checks passed
@lgalabru lgalabru deleted the feat/support-geyser-plugins branch February 12, 2025 03:12
Dodecahedr0x pushed a commit that referenced this pull request Feb 12, 2025
Dodecahedr0x pushed a commit that referenced this pull request Feb 12, 2025
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.

1 participant