Skip to content

Fix: some issues in the documentation.#1584

Merged
shargon merged 3 commits intoneo-project:master-n3from
Wi1l-B0t:fix.document-info
Apr 18, 2026
Merged

Fix: some issues in the documentation.#1584
shargon merged 3 commits intoneo-project:master-n3from
Wi1l-B0t:fix.document-info

Conversation

@Wi1l-B0t
Copy link
Copy Markdown
Contributor

Fix some issues in the documentation:

  • The framework has some SafeMath methods already.
  • The framework has Pow and Sqrt operations for BigInteger;
  • Don't add test cases to document;
  • The exception of Contract.Call cannot be caught;
  • Cannot limit the GAS consumption of Contract.Call at present.
  • There is no Security Test Automation Framework now.
  • ...

NOTE: Please review the AI generated content.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 16, 2026

Codecov Report

❌ Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.25%. Comparing base (0de2b46) to head (4d68db7).
⚠️ Report is 1 commits behind head on master-n3.

Files with missing lines Patch % Lines
...eo.SmartContract.Framework/Helpers/GuardHelpers.cs 0.00% 5 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/security/safe-arithmetic.md Outdated
Comment thread docs/security/safe-arithmetic.md
Comment thread docs/security/safe-arithmetic.md
Comment thread docs/security/security-best-practices.md
Comment thread docs/security/security-best-practices.md
Comment thread docs/security/security-testing.md
Comment thread docs/security/security-testing.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread src/Neo.SmartContract.Framework/Helpers/GuardHelpers.cs
Comment thread docs/security/safe-arithmetic.md Outdated
Comment thread docs/security/safe-arithmetic.md Outdated
Comment thread docs/security/security-best-practices.md Outdated
Comment thread docs/security/common-vulnerabilities.md Outdated
Comment thread guidance/security-guide.md
@Wi1l-B0t Wi1l-B0t force-pushed the fix.document-info branch 2 times, most recently from c432451 to a535fba Compare April 17, 2026 12:31
@Wi1l-B0t Wi1l-B0t force-pushed the fix.document-info branch from a535fba to 815d02a Compare April 17, 2026 12:32
@shargon shargon merged commit 3665f83 into neo-project:master-n3 Apr 18, 2026
4 of 5 checks passed
@ajara87
Copy link
Copy Markdown
Member

ajara87 commented Apr 18, 2026

lgtm

@Wi1l-B0t Wi1l-B0t deleted the fix.document-info branch April 20, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants