Fix: some issues in the documentation.#1584
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master-n3 #1584 +/- ##
==========================================
Coverage 80.24% 80.25%
==========================================
Files 295 295
Lines 25456 25456
Branches 3453 3453
==========================================
+ Hits 20428 20429 +1
Misses 4132 4132
+ Partials 896 895 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
8331220 to
88add28
Compare
There was a problem hiding this comment.
Pull request overview
Updates the security and arithmetic documentation to remove/replace AI-generated pseudo-code and align guidance with current Neo N3 Framework capabilities/limitations (e.g., existing SafeMath, availability of Pow/Sqrt, and Contract.Call behavior).
Changes:
- Removes large AI-generated “security automation / performance testing” code samples from security docs and replaces some sections with templates/bullets.
- Updates security best-practices guidance around
Contract.Call(no catchable exceptions / no gas limit enforcement). - Updates safe-arithmetic docs to reference framework
SafeMathand NeoVM-supported operations, and refines the BigInteger overflow description.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Neo.SmartContract.Framework/Helpers/GuardHelpers.cs | Changes default/assert fault strings used by GuardHelpers methods. |
| guidance/security-guide.md | Removes AI-generated “automated checklist” / incident enum sample and replaces with incident classification bullets + template. |
| docs/security/security-testing.md | Deletes large AI-generated sections on performance/load testing and a fictional “Security Test Automation Framework”. |
| docs/security/security-best-practices.md | Revises Contract.Call example to remove try/catch and gas-limiting claims. |
| docs/security/safe-arithmetic.md | Updates arithmetic examples to reference SafeMath, NeoVM Pow/Sqrt, and removes extensive test-case content. |
| docs/security/common-vulnerabilities.md | Updates overflow/underflow section to explain the 256-bit BigInteger limit and adjust prevention wording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c432451 to
a535fba
Compare
a535fba to
815d02a
Compare
|
lgtm |
Fix some issues in the documentation:
SafeMathmethods already.PowandSqrtoperations forBigInteger;Contract.Callcannot be caught;Contract.Callat present.NOTE: Please review the AI generated content.