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

docs: remove invariants #22126

Merged
merged 1 commit into from
Oct 4, 2024
Merged

docs: remove invariants #22126

merged 1 commit into from
Oct 4, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 4, 2024

Description

Crisis is dead, defining invariants is now useless.
This feature should potentially be included in simulations instead of being on chain concept because of DoS (cc @alpe)


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • Documentation

    • Updated the 01-module-manager.md to clarify module management in the Cosmos SDK, emphasizing streamlined interfaces and best practices.
    • Restructured 00-app-anatomy.md to enhance understanding of the core components of a Cosmos SDK application, including detailed explanations and a flowchart.
    • Removed 07-invariants.md, which previously detailed the concept and implementation of invariants within the SDK.
  • Chores

    • Modified context handling in the epoch.go file to align with standard Go practices while preserving functionality.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 4, 2024
@julienrbrt julienrbrt requested review from a team, alpe and facundomedica as code owners October 4, 2024 08:47
Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the documentation and interfaces related to module management in the Cosmos SDK. Key changes include a restructuring of the 01-module-manager.md document to clarify the roles of various application module interfaces and the introduction of new interfaces. The 07-invariants.md file has been deleted, reflecting a shift in focus. Additionally, modifications to the epoch.go file in the keeper package standardize context handling by replacing sdk.Context with context.Context in several methods.

Changes

File Path Change Summary
docs/build/building-modules/01-module-manager.md Updated to improve clarity and organization regarding module management, emphasizing the necessity of AppModule interfaces, refining application module interfaces, and enhancing the Manager structure section.
docs/build/building-modules/07-invariants.md Deleted file that documented invariants within the Cosmos SDK framework, including their implementation and significance.
docs/learn/beginner/00-app-anatomy.md Restructured and enhanced content to clarify core components of a Cosmos SDK application, including detailed explanations of application lifecycle functions and module interactions.
x/epochs/keeper/epoch.go Updated method signatures to change context type from sdk.Context to context.Context for several methods, preserving functionality while standardizing context handling.

Possibly related PRs

Suggested labels

C:x/epochs

Suggested reviewers

  • lucaslopezf
  • akhilkumarpilli
  • sontrinh16

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

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.

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
x/epochs/keeper/epoch.go (1)

EpochInfo.Walk method does not accept context.Context

The Walk method signature should be updated to accept context.Context to ensure compatibility.

🔗 Analysis chain

Line range hint 42-53: LGTM. Verify EpochInfo.Walk method compatibility with context.Context.

The change from sdk.Context to context.Context is consistent and the method adheres to the Uber Golang style guide.

Please verify that EpochInfo.Walk method is compatible with context.Context:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check EpochInfo.Walk method for context.Context compatibility

# Test: Search for EpochInfo type definition
rg --type go 'type\s+EpochInfo'

# Test: Check Walk method signature in EpochInfo or related types
rg --type go 'Walk\s*\(\s*context\.Context'

Length of output: 474

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dc14960 and 8166f85.

📒 Files selected for processing (4)
  • docs/build/building-modules/01-module-manager.md (0 hunks)
  • docs/build/building-modules/07-invariants.md (0 hunks)
  • docs/learn/beginner/00-app-anatomy.md (0 hunks)
  • x/epochs/keeper/epoch.go (1 hunks)
💤 Files with no reviewable changes (3)
  • docs/build/building-modules/01-module-manager.md
  • docs/build/building-modules/07-invariants.md
  • docs/learn/beginner/00-app-anatomy.md
🧰 Additional context used
📓 Path-based instructions (1)
x/epochs/keeper/epoch.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (3)
x/epochs/keeper/epoch.go (3)

Line range hint 59-67: LGTM. Ensure HeaderService compatibility as mentioned earlier.

The change from sdk.Context to context.Context is consistent and the method adheres to the Uber Golang style guide.

Please refer to the earlier comment about verifying HeaderService compatibility with context.Context.


Line range hint 17-39: LGTM. Verify HeaderService compatibility with context.Context.

The change from sdk.Context to context.Context is consistent and the method adheres to the Uber Golang style guide.

Please verify that HeaderService is compatible with context.Context:

#!/bin/bash
# Description: Check HeaderService implementation for context.Context compatibility

# Test: Search for HeaderService definition
rg --type go 'type\s+HeaderService'

# Test: Check HeaderInfo method signature in HeaderService
rg --type go 'HeaderInfo\s*\(\s*context\.Context\s*\)'

11-13: LGTM. Verify context usage across the codebase.

The change from sdk.Context to context.Context is consistent with the PR objective. The method adheres to the Uber Golang style guide.

To ensure consistency, please verify the context usage across the codebase:

✅ Verification successful

Verification Successful: No remaining sdk.Context usages found.

The shell scripts confirmed that there are no remaining instances of sdk.Context or cosmos-sdk/types.Context in the codebase. The transition to context.Context has been consistently applied across all relevant files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining usages of sdk.Context in Go files

# Test: Search for sdk.Context usage
rg --type go 'sdk\.Context'

# Test: Search for cosmos-sdk/types.Context usage
rg --type go 'cosmos-sdk/types\.Context'

Length of output: 474

@julienrbrt julienrbrt added this pull request to the merge queue Oct 4, 2024
Merged via the queue into main with commit 581a927 Oct 4, 2024
80 of 83 checks passed
@julienrbrt julienrbrt deleted the julien/docs-invariant branch October 4, 2024 12:27
mergify bot pushed a commit that referenced this pull request Oct 4, 2024
(cherry picked from commit 581a927)
@mergify mergify bot mentioned this pull request Oct 4, 2024
12 tasks
@tutufen tutufen mentioned this pull request Oct 5, 2024
@coderabbitai coderabbitai bot mentioned this pull request Oct 23, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/epochs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants