[DRAFT][WIP] Code cleanup & docs during audit process

[Olshansk]

Summary

Human Summary

AI Summary

reviewpad:summary

Issue

Fixes #<issue_number>

[Explain the reasoning for the PR in 1-2 sentences. Consider adding a link or a screenshot.]

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

Testing

• Run all unit tests: make test_all
• Run all/relevant benchmarks (if optimising): make benchmark_{all | suite name}

Required Checklist

• I have tested my changes using the available tooling
• I have performed a self-review of my own code
• I have commented my code (godoc format comments see: tip.golang.org/doc/comment)

If Applicable Checklist

• I have added tests that prove my fix is effective or that my feature works
• I have updated any relevant README(s)/documentation and left TODOs throughout the codebase
• Add or update any relevant or supporting mermaid diagrams

[codecov-commenter]

Codecov Report

Attention: 27 lines in your changes are missing coverage. Please review.

Comparison is base (8682379) 83.15% compared to head (03d85ea) 85.12%.

Files	Patch %	Lines
smt.go	93.58%	5 Missing and 5 partials ⚠️
kvstore/simplemap/simplemap.go	0.00%	4 Missing ⚠️
node_encoders.go	95.40%	2 Missing and 2 partials ⚠️
types.go	93.18%	3 Missing ⚠️
extension_node.go	97.50%	1 Missing and 1 partial ⚠️
lazy_node.go	0.00%	2 Missing ⚠️
smst.go	95.12%	1 Missing and 1 partial ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #40      +/-   ##
==========================================
+ Coverage   83.15%   85.12%   +1.97%     
==========================================
  Files           9       14       +5     
  Lines        1460     1526      +66     
==========================================
+ Hits         1214     1299      +85     
+ Misses        185      170      -15     
+ Partials       61       57       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Olshansk]

@h5law (not urgent)

Wanted to make sure you get an email/notification w.r.t these changes that I'm making. It's just naming, comments, and code refactoring from the perspective of someone who didn't implement the code and is exploring it for the first time.

The goal is to simply make it really easy for future readers of the code (who might not know how SMTs work) approach and contribute to it.