[Code Health] Improve the documentation, testing and overall health of the repo

[h5law]

Objective

In its current state, this repository can do with some improvements to help in its maintainability and further development.

This means increasing the amount of documentation, and tests (local and CI), as well as fixing the issues related to fuzzing.

Origin Document

Goals

• Improve the documentation in the repo
• Improve the testing framework
• Fix fuzzing
• Add benchmarks

Deliverable

• Improve the documentation in the repo
  • [ ] More descriptive README.md file, with a description of the project as well as examples
  • [ ] Improve Godoc comments in the source code
  • [ ] Add any further documentation as is necessary
• Improve the testing framework
  • [ ] Ensure maximum code coverage with unit tests
  • [ ] Integrate the repo with Codecov (as it previously was)
  • [ ] Setup CI workflows to test the repo
• Fix fuzzing
  • [ ] Look into oss-fuzz and fix its current implementation into the pokt-network/smt repo
  • [ ] Integrate fuzzing into the local test suite
  • [ ] Look into merging this PR which could integrate oss-fuzz into our CI workflows
• Add benchmarks
  • [ ] Add some benchmark tests that can be used for future performance enhancements to compare against

Non-goals / Non-deliverables

• Alter any logic relating to the SMT and its functionality outside of the realm of code cleanup

General issue deliverables

• [ ] Update any relevant README(s)
• [ ] Add or update any relevant or supporting mermaid diagrams

Testing Methodology

• [ ] Task specific tests or benchmarks: go test ...
• [ ] New tests or benchmarks: go test ...
• [ ] All tests: go test -v

---

Creator: @h5law Co-Owners: @h5law