Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Audit] Address Audit Issues and Suggestions #42

Merged
merged 6 commits into from
Apr 9, 2024
Merged

Conversation

h5law
Copy link
Collaborator

@h5law h5law commented Mar 19, 2024

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):

  • 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

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

@h5law h5law added documentation Improvements or additions to documentation enhancement New feature or request code health Related to code cleanup and health of the repo labels Mar 19, 2024
@h5law h5law requested review from red-0ne and Olshansk March 19, 2024 11:50
@h5law h5law self-assigned this Mar 19, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 19, 2024

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 ⚠️

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

Additional details and impacted files
@@            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              

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

Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not reviewed yet, but posting here for posterity. Let's split this PR into two:

  1. Audit remediations
  2. New requirements from poktroll

Screenshot 2024-03-20 at 11 15 58 AM

@h5law h5law force-pushed the audit-remediations branch from 9ea65a3 to 46dc5c5 Compare March 20, 2024 19:27
@h5law h5law requested a review from Olshansk March 20, 2024 19:30
@h5law h5law marked this pull request as draft March 22, 2024 13:29
@h5law h5law marked this pull request as ready for review March 26, 2024 16:43
@Olshansk Olshansk force-pushed the audit-remediations branch from 308f8a3 to 5199969 Compare April 8, 2024 23:13
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to get this over the finish line and other changes will come in the future

@Olshansk Olshansk merged commit 2ed21c3 into main Apr 9, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Related to code cleanup and health of the repo documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants