docs: Update reference of Approximation #22550
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request involves significant modifications to the security guidelines document for developers using the Cosmos stack. Enhancements include clearer language, expanded sections on non-determinism, in-protocol panics, unmetered computation, and fee market issues. The document now features acknowledgments and external references for better context. Specific risks and recommendations are outlined to improve understanding and handling of security considerations, ensuring developers are well-informed about potential vulnerabilities. Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 and nitpick comments (2)
docs/build/building-apps/04-security-part-1.md (2)
118-118: Consider using a more authoritative reference for approximation methods.While Wikipedia provides a good overview, for security-critical documentation, consider citing academic papers, technical specifications, or established mathematical libraries that implement these approximation methods.
Line range hint
1-400: Consider enhancing visibility of critical security warnings.While the documentation is comprehensive, consider adding prominent warning callouts (e.g., using blockquotes or bold text) for the most critical security considerations in each section. This would help developers quickly identify crucial security requirements.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
docs/build/building-apps/04-security-part-1.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/04-security-part-1.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🔇 Additional comments (2)
docs/build/building-apps/04-security-part-1.md (2)
Line range hint 1-24: Well-structured and comprehensive security documentation!
The document effectively presents security guidelines with a clear progression from fundamental concepts to advanced topics. The inclusion of acknowledgments and external references enhances credibility and provides additional resources for developers.
Line range hint 25-117: Technically accurate with practical code examples!
The documentation provides precise technical details with relevant code examples that effectively demonstrate security concepts. The examples are particularly valuable as they showcase real-world scenarios and common pitfalls.
Also applies to: 119-400
julienrbrt
added
the
backport/v0.52.x
Co-authored-by: Julien Robert <[email protected]> (cherry picked from commit bf6d6f3)
Co-authored-by: NAIHANU <[email protected]>
* main: build(deps): Bump cosmossdk.io/math from 1.3.0 to 1.4.0 (#22580) fix(server/v2/api/telemetry): enable global metrics (#22571) refactor(server/v2/cometbft): add `codec.Codec` and clean-up APIs (#22566) feat(core/coretesting): make memDB satisfy db.Db interface (#22570) Merge commit from fork fix(server(/v2)): fix fallback genesis path (#22564) fix: only overwrite context chainID when necessary (#22568) docs(client): Update setFeeGranter and setFeePayer comments (#22526) fix(baseapp): populate header info in `NewUncachedContext` (#22557) build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.35.1-20240701160653-fedbb9acfd2f.1 to 1.35.2-20240701160653-fedbb9acfd2f.1 in /api (#22551) build(deps): Bump github.com/creachadair/atomicfile from 0.3.5 to 0.3.6 in /tools/confix (#22552) docs: Update reference of Approximation (#22550) fix(server/v2/comebft): wire missing services + fix simulation (#21964) ci: fix permissions for GITHUB_TOKEN on dependabot workflows (#22547) ci: fix permissions for GITHUB_TOKEN in spell check workflow (#22545) build(deps): Bump google.golang.org/protobuf from 1.35.1 to 1.35.2 (#22537) fix(cosmovisor): premature upgrade on restart (#22528) fix(store/v2/pebble): handle version 0 in keys (#22524) refactor(server/v2/telemetry): swap redirects (#22520) docs: Update content in CODE_OF_CONDUCT.md (#22518)
it looks like the original link is deleted by the author, use wiki for updating.
Summary by CodeRabbit