pokt-network / smt

A Go library that implements a Sparse Merkle Trie for a key-value map.
https://pkg.go.dev/github.com/pokt-network/smt
Other
16 stars 4 forks source link

[Audit] Address Audit Issues and Suggestions #42

Closed h5law closed 6 months ago

h5law commented 7 months ago

Summary

Human Summary

This PR addresses Issues A and B by providing extra documentation related to the usage of hashing algorithms and the writability of the key-value store. As these are related to the usage of the SMT documentation guidance on best practices for the security of the trie is needed.

Suggestions 1 and 3 have been addressed with the consolidation of the ClosestProof verification method's API and the way in which ExtentionNodes are created with regards to the usage of shared pointers.

AI Summary

reviewpad:summary

Issue

Fixes N/A

Audit Report: Audit Report.pdf

Type of change

Please mark the relevant option(s):

Testing

Required Checklist

If Applicable Checklist

codecov-commenter commented 7 months ago

Codecov Report

Attention: Patch coverage is 76.00000% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 82.87%. Comparing base (8682379) to head (46dc5c5).

Files Patch % Lines
proofs.go 57.14% 12 Missing :warning:

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #42 +/- ## ========================================== - Coverage 83.15% 82.87% -0.28% ========================================== Files 9 9 Lines 1460 1489 +29 ========================================== + Hits 1214 1234 +20 - Misses 185 194 +9 Partials 61 61 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.