docs(docs/build/building-apps): update docs #23713
Conversation
📝 WalkthroughWalkthroughThis pull request updates the Cosmos SDK documentation and upgrade guide. In the security documentation, the Changes
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/build/building-apps/upgrades/0.52.md (1)
429-498: 🛠️ Refactor suggestionRemoval of AppModuleBasic: Merging into Unified AppModule Structure
The comprehensive changes mergingAppModuleBasicintoAppModulesimplify the module’s entry point. Note the following:
- The
Name()function now belongs solely toAppModule.- Both legacy codec registration and genesis validation functions have been adjusted accordingly.
Double-check that all module consumers have been updated to reflect these changes and that the removal of the embedded basic module does not break backward compatibility.
🧹 Nitpick comments (2)
docs/build/building-apps/upgrades/0.52.md (2)
180-188: AppConfig Update: Introducing SkipStoreKeys for Modules Without Keys
Adding theSkipStoreKeysfield improves configurability for modules that do not require a KV store. Consider providing an example in the documentation to illustrate when this field should be used.
383-383: Typo Correction: Fix Spelling Mistake
The pipeline indicates a typo on line 383 where "fot" should be "for". Please update the text accordingly to maintain professionalism and readability.- ... cost fot the development team ... + ... cost for the development team ...🧰 Tools
🪛 GitHub Actions: Spell Check
[warning] 383-383: Typo found: 'fot' should be 'for'.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/build/building-apps/04-security-part-1.md(1 hunks)docs/build/building-apps/upgrades/0.52.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/build/building-apps/04-security-part-1.mddocs/build/building-apps/upgrades/0.52.md
🪛 GitHub Actions: Spell Check
docs/build/building-apps/upgrades/0.52.md
[warning] 383-383: Typo found: 'fot' should be 'for'.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (11)
docs/build/building-apps/upgrades/0.52.md (10)
98-105: Client Wiring Update: Added Builder Methods for Address/Validator/Consensus Codecs
The added method calls (WithAddressCodec(),WithValidatorAddressCodec(),WithConsensusAddressCodec(), along with prefix settings) clearly enhance client configuration by replacing global constructs. Ensure that these changes are consistently reflected in your overall client setup documentation.
110-112: Server Command Options Update: Transition to Typed Start Command Options
Replacing the anonymous function withserver.StartCmdOptions[servertypes.Application]standardizes the server command initialization. Verify that downstream code references the new type safely.
126-131: Module Manager Registration Update: Simplifying Legacy Manager Usage
Changing from the deprecated BasicModuleManager to directly invoking registration onapp.ModuleManagersimplifies the module management. Confirm that no residual references to the BasicModuleManager remain elsewhere in the codebase.
200-206: Protobuf Options Revision: Updating Any Type Mapping
The change to mapgoogle/protobuf/any.prototogithub.heygears.com/cosmos/gogoproto/types/anyreflects recent package relocations and promotes consistency in protobuf code generation.
223-225: Module Import Refactoring: Updating govtypes Path
Switching the import path forgovtypestocosmossdk.io/x/gov/typesaligns the module imports with the new structure, facilitating future maintenance.
246-248: Interface Registry Update: Function Signature Adjustment
Modifying theRegisterInterfacesfunction signature to useregistry.InterfaceRegistrarmodernizes the registration process. Ensure that any dependent modules are likewise updated to accept the new interface.
256-258: Amino Codec Registry Update: Embracing New Registrar Interface
Updating theRegisterLegacyAminoCodecfunction signature to accept aregistry.AminoRegistrarclarifies responsibilities and paves the way for a gradual migration away from legacy codecs.
266-268: MsgSimulatorFn Signature Change: Enhanced Error-Handling
The update of theMsgSimulatorFnsignature—now returning an error and eschewingsdk.Contextin favor of an address.Codec as a parameter—improves simulation robustness, making error handling explicit.
277-281: Depinject AppConfig Import Update: Reflecting Module Reorganization
The change to import fromcosmossdk.io/depinject/appconfiginstead of the old core path aligns dependency injection with the new module organization.
291-299: Genesis Interfaces Update: Transitioning to Context-Based Signatures
The adjustments in bothInitGenesisandExportGenesisfunctions, replacingsdk.Contextwithcontext.Context(and adding error returns), modernize the genesis process and error management.docs/build/building-apps/04-security-part-1.md (1)
275-283: Error Handling Improvement in HasAnyAtPrefix Function
The update to useerrors.Is(err, ErrNoValuesInRange)instead of a plain error comparison enables more flexible and reliable error handling in the key iteration logic. This improvement is crucial for accurately detecting the absence of values and preventing false positives in security checks.
update docs
Summary by CodeRabbit
Documentation
New Features