evm: proofread README and typedoc comments

[ScottyPoi]

• Proofread README.md: fixed idioms, grammar/parallelism, clarified messaging, polished the profiling intro, and corrected CLI/debug references.

• Added missing TypeDoc coverage

  • stack operations
  • stem-cache size()
  • precompile helpers
  • BLS utilities
  • EOF helpers
  • ExecResult factory functions

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.81%. Comparing base (05381c6) to head (7c55ae8).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files

Flag	Coverage Δ
block	87.81% <ø> (ø)
blockchain	89.37% <ø> (ø)
common	96.75% <ø> (ø)
evm	72.39% <ø> (ø)
mpt	90.36% <ø> (+0.61%)	⬆️
statemanager	80.21% <ø> (ø)
static	99.77% <ø> (ø)
tx	88.35% <ø> (ø)
util	89.62% <ø> (ø)
vm	57.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull Request Overview

This pull request improves code documentation and readability by enhancing JSDoc comments across multiple files and correcting spelling/grammatical errors in the README.

• Adds comprehensive JSDoc comments with parameter descriptions and return value documentation for utility functions and helper methods
• Fixes spelling and grammatical errors in README (e.g., "till" → "to", "Build-in" → "Built-in")
• Improves clarity of existing documentation with more detailed parameter and return value descriptions

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/evm/src/stemCache.ts	Adds return value documentation for the size() method
packages/evm/src/stack.ts	Adds detailed JSDoc comments for stack manipulation methods (push, pop, popN, peek, swap, dup) but creates duplicate documentation blocks
packages/evm/src/precompiles/util.ts	Enhances JSDoc comments with parameter descriptions and return value documentation for gas and length check functions
packages/evm/src/precompiles/bls12_381/util.ts	Improves JSDoc comments with detailed parameter and return value descriptions for BLS utility functions
packages/evm/src/evm.ts	Adds comprehensive JSDoc comments for result generation helper functions
packages/evm/src/eof/container.ts	Adds parameter and return value documentation for readUint16 and validateEOF functions
packages/evm/README.md	Corrects spelling and grammatical errors throughout the documentation

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.