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: linting fixes #19855

Merged
merged 3 commits into from
Mar 25, 2024
Merged

chore: linting fixes #19855

merged 3 commits into from
Mar 25, 2024

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Mar 25, 2024

Description

Some minor linting fixes and fix noflag rocksdb


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Refactor
    • Improved database initialization by adding a name parameter and removing obsolete code.
    • Enhanced performance and code clarity in proof commitment operations.
    • Updated parameter set handling for tests to use a more explicit and type-safe approach.

@tac0turtle tac0turtle marked this pull request as ready for review March 25, 2024 14:27
@tac0turtle tac0turtle requested a review from a team as a code owner March 25, 2024 14:27
Copy link
Contributor

coderabbitai bot commented Mar 25, 2024

Walkthrough

The recent updates involve refining the codebase by optimizing function parameters and data handling. Specifically, adjustments were made to the NewRocksDB function, including the addition of a name parameter and the removal of the grocksdb package dependency. Additionally, the handling of arguments and encoding in certain functions was streamlined, eliminating unnecessary conversions. In testing, there was a shift towards using a custom type for parameter set pairs, enhancing clarity and structure.

Changes

Files Change Summary
store/db/rocksdb_noflag.go Added name parameter to NewRocksDB, removed grocksdb package references, and deleted unused functions.
store/proof/commit_info.go Streamlined argument passing and encoding to eliminate unnecessary []byte() conversions.
x/params/types/.../common_test.go Updated parameter set pairs handling to use types.ParamSetPair with explicit field assignments.

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 00b2b9d and 85d5fdf.
Files selected for processing (3)
  • store/db/rocksdb_noflag.go (4 hunks)
  • store/proof/commit_info.go (4 hunks)
  • x/params/types/common_test.go (1 hunks)
Additional comments: 6
store/db/rocksdb_noflag.go (2)
  • 21-21: The addition of the name parameter to the NewRocksDB function is a good practice for clarity and explicitness in database operations. This change enhances the maintainability of the codebase.
  • 6-11: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of references to the grocksdb package and unused functions related to grocksdb, as mentioned in the PR summary, is a positive step towards simplifying the codebase. This aligns with best practices for maintainability and performance.

x/params/types/common_test.go (2)
  • 81-83: Switching to types.ParamSetPair with explicit field assignments in the ParamSetPairs method for params enhances code readability, consistency, and the robustness of parameter management. This change aligns well with the Uber Golang style guide.
  • 89-92: The use of types.ParamSetPair with explicit field assignments in the ParamSetPairs method for paramsV2 is a commendable improvement. It enhances readability, consistency, and parameter management, aligning with the Uber Golang style guide.
store/proof/commit_info.go (2)
  • 78-78: Using si.Name and storeKey directly instead of unnecessary []byte() conversions in the LeafHash and ConvertCommitmentOp functions is a good optimization. This improves argument passing efficiency and code clarity.

Also applies to: 88-88

  • 99-99: Removing unnecessary []byte() conversions in the encoding of storeInfo.Name in the encodedSize and Marshal functions is a positive optimization. It enhances the efficiency and clarity of the encoding process.

Also applies to: 127-127

@julienrbrt julienrbrt added this pull request to the merge queue Mar 25, 2024
Merged via the queue into main with commit 138db2b Mar 25, 2024
60 of 61 checks passed
@julienrbrt julienrbrt deleted the marko/linting_fixes branch March 25, 2024 17:05
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants