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

chore: disable alloy default features #131

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Conversation

shuhuiluo
Copy link
Owner

@shuhuiluo shuhuiluo commented Feb 5, 2025

Updated Cargo.toml to disable default features for the alloy crate, ensuring more controlled dependency management. Added specific alloc imports for Vec and ToString in various modules to address compilation requirements. Incremented the library version and adjusted workflows for enhanced build validation with extension features.

Summary by CodeRabbit

  • New Features
    • Enhanced the build process with an added configuration step to support extended functionality.
  • Documentation
    • Updated release version details and refined example code for clearer usage.
  • Chores
    • Upgraded dependencies and adjusted configurations to improve overall project stability and consistency.

Updated Cargo.toml to disable default features for the alloy crate, ensuring more controlled dependency management. Added specific `alloc` imports for `Vec` and `ToString` in various modules to address compilation requirements. Incremented the library version and adjusted workflows for enhanced build validation with extension features.
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

The pull request updates multiple aspects of the project. The CI workflow now includes a new step to build with the “extensions” feature enabled. Updates in the package configuration bump the versions in both Cargo.toml and README, while dependency settings for alloy and uniswap-lens have been refined. Several source files in the extensions module receive minor import adjustments, and a new ticks field is added to dynamically store tick data. Bazinga.

Changes

File(s) Change Summary
.github/workflows/rust.yml Added a new step "Build with extensions" in the "test" job to execute cargo build --features extensions after the standard cargo build.
Cargo.toml & README.md Bumped package version (Cargo.toml: "3.5.0" → "3.5.1"; README: "3.4.0" → "3.5.0"), updated dependency versions (uniswap-lens and alloy), and disabled alloy default features; README also simplifies example code by removing an unused variable.
src/extensions/ephemeral_tick_data_provider.rs Imported alloc::vec::Vec and added pub ticks: Vec<Tick<I>> to the EphemeralTickDataProvider struct, updating its constructor to collect tick data dynamically.
src/extensions/{pool.rs, position.rs, tick_bit_map.rs, tick_map.rs} Modified imports: In pool.rs, added alloc imports (string::ToString, vec, vec::Vec); in position.rs, added alloc::string::ToString; in tick_bit_map.rs, added use alloy::uint; in tick_map.rs, removed alloy::uint and added alloc::vec::Vec.

Sequence Diagram(s)

sequenceDiagram
    participant CI as GitHub Actions
    participant Build as Standard Build
    participant ExtBuild as Extended Build

    CI->>Build: Run `cargo build`
    Build-->>CI: Build complete
    CI->>ExtBuild: Run `cargo build --features extensions`
    ExtBuild-->>CI: Extended build complete
Loading

Possibly related PRs

Poem

In a world of code so grand,
A new build step takes the stand.
Versions rise and imports align,
Ticks flowing in a dynamic design.
Bazinga, our code now shines!

(∴ The logic is sound.)

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e59a01 and f483f05.

📒 Files selected for processing (8)
  • .github/workflows/rust.yml (1 hunks)
  • Cargo.toml (4 hunks)
  • README.md (2 hunks)
  • src/extensions/ephemeral_tick_data_provider.rs (1 hunks)
  • src/extensions/pool.rs (1 hunks)
  • src/extensions/position.rs (1 hunks)
  • src/extensions/tick_bit_map.rs (1 hunks)
  • src/extensions/tick_map.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Rust Tests
🔇 Additional comments (9)
src/extensions/ephemeral_tick_data_provider.rs (1)

5-5: Fascinating addition of Vec import and field!

The explicit import of alloc::vec::Vec and its usage in the struct demonstrates proper memory management practices. As someone who appreciates order and precision, I must say this is quite satisfactory.

Also applies to: 20-20

src/extensions/tick_map.rs (1)

6-7: Excellent reorganization of imports!

The consolidation of imports through alloy_primitives is logically superior to the previous arrangement. It's like organizing my comic books by publisher, then alphabetically.

.github/workflows/rust.yml (1)

62-63: Bazinga! A logical enhancement to the CI workflow!

Adding a dedicated build step for extensions is like having a separate shelf for my vintage Star Trek memorabilia - it ensures everything has its proper place and validation.

Cargo.toml (1)

3-3: Impeccable version management and dependency configuration!

The systematic version increment and precise control over features is commendable. However, as a theoretical physicist who appreciates verification...

Let's verify the compatibility of these versions:

Also applies to: 18-18, 32-32, 41-41

src/extensions/tick_bit_map.rs (1)

7-7: Optimal Import Usage: Adding the uint import from alloy_primitives is a precise and necessary step given the disabled default features. Bazinga.

README.md (2)

53-54: Version Bump Notice: The Cargo.toml update to version "3.5.0" is appropriately executed to reflect the dependency changes. Excellent work.


91-91: Refined Example Code: Removing the unnecessary intermediate variable in the example enhances clarity and adheres to the KISS principle. Fortuitously logical.

src/extensions/pool.rs (1)

7-7: Enhanced Imports: Incorporating alloc::{string::ToString, vec, vec::Vec} is a wise move to bolster dynamic vector and string conversion support. Logically sound.

src/extensions/position.rs (1)

7-7: Strategic Import Addition: The new import of alloc::string::ToString seamlessly enables string conversion functionality. I must say, it is impeccably appropriate.


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.

@shuhuiluo shuhuiluo merged commit 426ccc3 into master Feb 5, 2025
3 checks passed
@shuhuiluo shuhuiluo deleted the default-features branch February 5, 2025 05:10
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