fix linter #2839

GAtom22 · 2024-09-09T19:56:11Z

Description

Closes: #XXXX

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...

tackled an existing issue or discussed with a team member
left instructions on how to review the changes
targeted the correct branch (see PR Targeting)

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...

added a relevant changelog entry to the Unreleased section in CHANGELOG.md
confirmed all author checklist items have been addressed
confirmed that this PR does not change production code
reviewed content
tested instructions (if applicable)
confirmed all CI checks have passed

Summary by CodeRabbit

Documentation
- Updated comments across various files to enhance clarity regarding linting directives and suppress specific security warnings.
Chores
- Added //nolint:gosec // G115 comments to multiple functions to indicate intentional bypassing of certain linting warnings without altering functionality.

coderabbitai · 2024-09-09T19:56:19Z

Walkthrough

The pull request introduces several modifications across various files, primarily focusing on updating comments to suppress specific linting warnings related to security checks. The changes involve replacing existing lint directives with more explicit annotations or adding new comments to indicate that certain lines should be exempt from static analysis warnings. The overall functionality of the affected methods and tests remains unchanged.

Changes

Files	Change Summary
`app/ante/evm/12_emit_event.go`, `app/ante/evm/mono.go`	Updated comments for `txIdx` variable to suppress `gosec` warnings G115 and G701.
`ibc/testing/endpoint.go`	Added comment to `zeroTimestamp` variable to ignore `gosec` warning G115.
`indexer/kv_indexer.go`	Added comments to suppress `gosec` warning G115 for `TxIndexKey` function.
`precompiles/authorization/events.go`, `precompiles/distribution/events.go`, `precompiles/erc20/events.go`, `precompiles/staking/events.go`, `precompiles/ics20/events.go`	Added `//nolint:gosec // G115` comments to `BlockNumber` assignments in various event emission functions.
`precompiles/distribution/events_test.go`, `precompiles/staking/events_test.go`, `precompiles/erc20/events_test.go`, `precompiles/vesting/events_test.go`, `rpc/backend/blocks_test.go`, `rpc/backend/tx_info.go`, `x/evm/keeper/state_transition_test.go`	Added `//nolint:gosec // G115` comments to assertions comparing block numbers in various test functions.
`rpc/backend/backend_suite_test.go`, `rpc/backend/blocks.go`, `rpc/backend/node_info.go`, `rpc/backend/utils.go`, `x/inflation/v1/keeper/epoch_info.go`	Updated comments to suppress `gosec` warnings for various lines of code.
`tests/e2e/upgrade/manager.go`, `testutil/integration/evmos/network/network.go`, `testutil/integration/evmos/utils/genesis.go`, `testutil/tx/eth.go`, `types/int.go`, `x/evm/keeper/grpc_query.go`, `x/evm/keeper/keeper.go`, `x/inflation/v1/keeper/hooks_test.go`	Added or updated comments to suppress specific `gosec` warnings in various functions.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Linter
    participant Codebase

    Developer->>Codebase: Update comments to suppress lint warnings
    Codebase->>Linter: Run static analysis
    Linter-->>Codebase: Ignore specified warnings
    Codebase-->>Developer: Maintain functionality

🐰 In the code where I hop and play,
Linting rules kept worries at bay.
With comments clear, I skip the fuss,
My code is safe, no need to rush!
Hooray for changes, let’s all cheer,
For clean code brings us all good cheer! 🎉

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 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 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 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 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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4265aa3 and 069ef83.

Files selected for processing (36)

app/ante/evm/12_emit_event.go (1 hunks)
app/ante/evm/mono.go (1 hunks)
ibc/testing/endpoint.go (1 hunks)
indexer/kv_indexer.go (1 hunks)
precompiles/authorization/events.go (2 hunks)
precompiles/distribution/events.go (5 hunks)
precompiles/distribution/events_test.go (5 hunks)
precompiles/erc20/events.go (2 hunks)
precompiles/erc20/events_test.go (2 hunks)
precompiles/ics20/events.go (1 hunks)
precompiles/staking/events.go (8 hunks)
precompiles/staking/events_test.go (7 hunks)
precompiles/staking/tx_test.go (5 hunks)
precompiles/staking/utils_test.go (1 hunks)
precompiles/testutil/events.go (1 hunks)
precompiles/vesting/events.go (7 hunks)
precompiles/vesting/tx_test.go (2 hunks)
precompiles/vesting/utils_test.go (1 hunks)
rpc/backend/backend_suite_test.go (2 hunks)
rpc/backend/blocks.go (2 hunks)
rpc/backend/blocks_test.go (2 hunks)
rpc/backend/node_info.go (1 hunks)
rpc/backend/tx_info.go (7 hunks)
rpc/backend/utils.go (1 hunks)
rpc/types/events.go (1 hunks)
rpc/types/utils.go (3 hunks)
tests/e2e/upgrade/manager.go (1 hunks)
testutil/integration/evmos/network/network.go (1 hunks)
testutil/integration/evmos/utils/genesis.go (1 hunks)
testutil/tx/eth.go (1 hunks)
types/int.go (1 hunks)
x/evm/keeper/grpc_query.go (3 hunks)
x/evm/keeper/keeper.go (2 hunks)
x/evm/keeper/state_transition_test.go (3 hunks)
x/inflation/v1/keeper/epoch_info.go (1 hunks)
x/inflation/v1/keeper/hooks_test.go (1 hunks)

Files skipped from review due to trivial changes (35)

app/ante/evm/12_emit_event.go
ibc/testing/endpoint.go
indexer/kv_indexer.go
precompiles/authorization/events.go
precompiles/distribution/events.go
precompiles/distribution/events_test.go
precompiles/erc20/events.go
precompiles/erc20/events_test.go
precompiles/ics20/events.go
precompiles/staking/events.go
precompiles/staking/events_test.go
precompiles/staking/tx_test.go
precompiles/staking/utils_test.go
precompiles/testutil/events.go
precompiles/vesting/events.go
precompiles/vesting/tx_test.go
precompiles/vesting/utils_test.go
rpc/backend/backend_suite_test.go
rpc/backend/blocks.go
rpc/backend/blocks_test.go
rpc/backend/node_info.go
rpc/backend/tx_info.go
rpc/backend/utils.go
rpc/types/events.go
rpc/types/utils.go
tests/e2e/upgrade/manager.go
testutil/integration/evmos/network/network.go
testutil/integration/evmos/utils/genesis.go
testutil/tx/eth.go
types/int.go
x/evm/keeper/grpc_query.go
x/evm/keeper/keeper.go
x/evm/keeper/state_transition_test.go
x/inflation/v1/keeper/epoch_info.go
x/inflation/v1/keeper/hooks_test.go

Additional comments not posted (1)

app/ante/evm/mono.go (1)

312-312: LGTM!

The comment change from // nosec: G701 to //nolint:gosec // G115 G701 provides more explicit linter directives to suppress specific security warnings. This change improves the clarity of the code without affecting its functionality.

GAtom22 · 2024-09-09T20:28:25Z

https://github.com/Mergifyio backport rama/release-v20

mergify · 2024-09-09T20:28:32Z

backport rama/release-v20

✅ Backports have been created

#2842 fix linter (backport #2839) has been created for branch rama/release-v20

* fix linter * run make format --------- Co-authored-by: GAtom22 <GAtom22@users.noreply.github.com> Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> (cherry picked from commit 0822b8f)

fix linter (#2839) * fix linter * run make format --------- Co-authored-by: GAtom22 <GAtom22@users.noreply.github.com> Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> (cherry picked from commit 0822b8f) Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com>

fix linter

3050fa6

GAtom22 temporarily deployed to release September 9, 2024 19:56 — with GitHub Actions Inactive

github-actions bot added types tests precompile labels Sep 9, 2024

run make format

069ef83

dev-evmos temporarily deployed to release September 9, 2024 19:57 — with GitHub Actions Inactive

GAtom22 marked this pull request as ready for review September 9, 2024 20:10

GAtom22 requested a review from a team as a code owner September 9, 2024 20:10

GAtom22 requested review from MalteHerrmann and 0xstepit and removed request for a team September 9, 2024 20:10

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

fedekunze approved these changes Sep 10, 2024

View reviewed changes

Merge branch 'main' into fix-lint

3c47589

0xstepit approved these changes Sep 10, 2024

View reviewed changes

0xstepit temporarily deployed to release September 10, 2024 08:26 — with GitHub Actions Inactive

Merge branch 'main' into fix-lint

4343787

0xstepit temporarily deployed to release September 10, 2024 08:42 — with GitHub Actions Inactive

0xstepit merged commit 0822b8f into main Sep 10, 2024
48 of 51 checks passed

0xstepit deleted the fix-lint branch September 10, 2024 09:44

mergify bot mentioned this pull request Sep 10, 2024

fix linter (backport #2839) #2842

Merged

9 tasks

This was referenced Sep 16, 2024

feat(precompile): add gov precompile (vote only) #2858

Merged

chore(evm): Remove unused ChainID from Evm keeper. #2873

Merged

coderabbitai bot mentioned this pull request Sep 30, 2024

feat(app): add feemarket wrapper. Change basefee to dec #2878

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix linter #2839

fix linter #2839

Uh oh!

GAtom22 commented Sep 9, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 9, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

GAtom22 commented Sep 9, 2024

Uh oh!

mergify bot commented Sep 9, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

fix linter #2839

fix linter #2839

Uh oh!

Conversation

GAtom22 commented Sep 9, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

GAtom22 commented Sep 9, 2024

Uh oh!

mergify bot commented Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Uh oh!

Uh oh!

GAtom22 commented Sep 9, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 9, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mergify bot commented Sep 9, 2024 •

edited

Loading