docs: Add documentation for debugging transactions

[victor-yanev]

Description:

This PR adds a new file debugging-transactions.md to provide detailed guidance on debugging transactions using Remix IDE, the Truffle CLI and how to manually call the debug_traceTransaction method.

Changes:

• Added debugging-transactions.md to the docs directory.
• The new documentation includes:
  • An overview of debugging tools in Remix.
  • Steps to use the built-in debugger in Remix.
  • Examples of debugging a transaction using the built-in debugger.
  • Steps to use the debugging tool from Truffle
  • Examples of debugging a transaction with Truffle
  • Instructions for manually calling the debug_traceTransaction method.
  • Examples of using debug_traceTransaction with callTracer and opcodeLogger.

Motivation:
The addition of this documentation aims to help developers effectively debug their smart contracts by providing comprehensive instructions and examples.

Related issue(s):

Fixes #2432

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[github-actions]

🚨 Memory Leak Detected 🚨

A potential memory leak has been detected in the test titled should execute "eth_getTransactionByHash with missing transaction". This may impact the application's performance and stability.

Details

📊 Memory Leak Detection Report 📊

GC Type: MarkSweepCompact
Cost: 40,659.4 ms

Heap Statistics (before vs after executing the test):

• Total Heap Size: increased with 786.43 KB
• Total Heap Size Executable: no changes
• Total Physical Size: increased with 786.43 KB
• Total Available Size: increased with 1.57 MB
• Total Global Handles Size: no changes
• Used Global Handles Size: decreased with 64.00 bytes
• Used Heap Size: decreased with 2.55 MB
• Heap Size Limit: no changes
• Malloced Memory: no changes
• External Memory: no changes
• Peak Malloced Memory: no changes

Heap Space Statistics (before vs after executing the test):

• Old Space:
  • Space Size: increased with 786.43 KB
  • Space Used Size: increased with 544.38 KB
  • Space Available Size: decreased with 467.14 KB
  • Physical Space Size: increased with 786.43 KB

Recommendations

Please investigate the memory allocations in this test, focusing on objects that are not being properly deallocated.

[github-actions]

Tests

    3 files  165 suites   14s ⏱️
885 tests 884 ✔️ 1 💤 0 ❌
898 runs  897 ✔️ 1 💤 0 ❌

Results for commit 884465e.

♻️ This comment has been updated with latest results.

[github-actions]

Acceptance Tests

  19 files  222 suites   30m 14s ⏱️
613 tests 607 ✔️ 4 💤 2 ❌
648 runs  642 ✔️ 4 💤 2 ❌

Results for commit 884465e.

♻️ This comment has been updated with latest results.

[acuarica]

Should we use docs: instead of chore: for the PR title?

[acuarica]

lg, left some comments we can iterate on

[david-bakin-sl]

Very nice - and definitely needed! I feel like I could do it now.

LGTM but there are a couple of suggestions if you like.

[acuarica]

looking good

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.86%. Comparing base (265e137) to head (884465e).
Report is 55 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2774      +/-   ##
==========================================
+ Coverage   77.06%   77.86%   +0.79%     
==========================================
  Files          40       43       +3     
  Lines        3266     3329      +63     
  Branches      683      706      +23     
==========================================
+ Hits         2517     2592      +75     
+ Misses        529      491      -38     
- Partials      220      246      +26     

Flag	Coverage Δ
relay	78.95% <ø> (?)
server	74.61% <ø> (?)
ws-server	61.70% <ø> (?)

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

see 15 files with indirect coverage changes

[david-bakin-sl]

LGTM!