onflow / atree

Atree provides scalable arrays and scalable ordered maps.

https://onflow.org

Apache License 2.0

40 stars 16 forks source link

Update CircleHash to newer version #244

Closed fxamacker closed 2 years ago

fxamacker commented 2 years ago

Description

Update to newer version of CircleHash64 which is faster and 100% backward compatible.
Update README to add section "OMT uses CircleHash64 with Deferred+Segmented BLAKE3 Digests"
- Show comparison of CircleHash64 vs SipHash, and BLAKE3 vs SHA3-256 to help explain our algorithm choices

Closes #243

[x] Targeted PR against main branch
[x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work
[x] Code follows the standards mentioned here
[x] Updated relevant documentation
[x] Re-reviewed Files changed in the Github PR explorer
[x] Added appropriate labels

codecov-commenter commented 2 years ago

Codecov Report

Merging #244 (a300fa7) into main (0836f0e) will increase coverage by 0.04%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #244      +/-   ##
==========================================
+ Coverage   68.93%   68.97%   +0.04%     
==========================================
  Files          14       14              
  Lines        7245     7245              
==========================================
+ Hits         4994     4997       +3     
+ Misses       1619     1617       -2     
+ Partials      632      631       -1

Impacted Files	Coverage Δ
map.go	`71.41% <0.00%> (+0.10%)`	:arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 0836f0e...a300fa7. Read the comment docs.

fxamacker commented 2 years ago

In case we do not already have some, maybe it would be great to have some regression tests here in atree that assert expected hash output for some values

@turbolent That's a great idea! I'm going to include that before merging this PR.

fxamacker commented 2 years ago

I opened PR https://github.com/onflow/atree/pull/247 to add regression/compatibility test. It's a subset of tests copied from circlehash.

turbolent commented 2 years ago

@fxamacker Please feel free to merge, I also approved #247