dydxprotocol / v4-chain

dydx v4 protocol
Other
231 stars 105 forks source link

Use Rust proto crate name as `dydx-proto` #2543

Closed v0-e closed 2 weeks ago

v0-e commented 2 weeks ago

Changelist

Changes Rust protocol buffers crate name to dydx-proto, removing the -rust, since the crate name is available and using -rust is redundant in Rust code.

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request involve renaming the Rust crate from "dydx-proto-rust" to "dydx-proto" across several files. The modifications are primarily found in Cargo.toml, README.md, and deny.toml, where the package name and dependency references have been updated to reflect this new name. No other attributes or settings in these files have been altered.

Changes

File Change Summary
v4-proto-rs/Cargo.toml Package name updated from "dydx-proto-rust" to "dydx-proto"
v4-proto-rs/README.md Dependency name updated from dydx-proto-rust to dydx-proto
v4-proto-rs/deny.toml License clarification updated from "dydx-proto-rust" to "dydx-proto"

Possibly related PRs

Suggested reviewers

Poem

In a meadow where the bunnies play,
A name was changed, hip-hip-hooray!
From "rust" to "proto," a leap so spry,
Hopping along, we reach for the sky!
With every change, we dance and cheer,
For a brighter name, we hold so dear! 🐇✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between b5a95d48839a942f9d18b16e91278dfb9bb46d0c and 017c3f094f8750904ef4f0267b8e38a8d99fd500.
📒 Files selected for processing (3) * v4-proto-rs/Cargo.toml (1 hunks) * v4-proto-rs/README.md (1 hunks) * v4-proto-rs/deny.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1) * v4-proto-rs/Cargo.toml
🔇 Additional comments (3)
v4-proto-rs/deny.toml (1)
`34-34`: **LGTM! Crate name update aligns with PR objectives.** The change correctly updates the crate name in the license clarification section while maintaining the same license expression and file hash. Let's verify consistency with Cargo.toml:
✅ Verification successful **Crate name update is consistent across files** ✅ The verification confirms: - Cargo.toml correctly uses the new name `dydx-proto` - No remaining references to the old name `dydx-proto-rust` were found - The change in deny.toml is properly aligned with the package name
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify that the crate name in Cargo.toml matches the one in deny.toml # Test: Search for package name in Cargo.toml. Expect: name = "dydx-proto" rg -A 1 'name\s*=' v4-proto-rs/Cargo.toml # Test: Search for any remaining references to old crate name. Expect: No matches rg 'dydx-proto-rust' v4-proto-rs/ ``` Length of output: 115
v4-proto-rs/README.md (2)
`9-9`: **LGTM! Dependency name updated correctly.** The dependency declaration has been updated from `dydx-proto-rust` to `dydx-proto` as intended. --- Line range hint `1-100`: **Verify no remaining references to old crate name.** Let's verify that no other mentions of the old crate name `dydx-proto-rust` remain in the README.
✅ Verification successful **No references to old crate name found** The search results confirm that only the new crate name `dydx-proto` is used in the README.md and Cargo.toml files. There are no remaining references to the old crate name `dydx-proto-rust`.
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Search for any remaining references to the old crate name rg "dydx-proto-rust" "v4-proto-rs/README.md" # Also check other potential documentation files that might need updates fd -t f "README|\.md$" -X rg "dydx-proto-rust" ``` Length of output: 89 --- Script: ```shell #!/bin/bash # Let's verify by searching for both the old and new crate names to ensure we have context rg -i "dydx.?proto" "v4-proto-rs/README.md" # Also check Cargo.toml for the crate name cat "v4-proto-rs/Cargo.toml" # Check other potential documentation files fd -t f "README|\.md$" -X rg -i "dydx.?proto" ``` Length of output: 8817
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.