5.1.0 Release Notes

[antiochp]

v5.1.0

Release: https://github.com/mimblewimble/grin/releases/tag/v5.1.0

Changes

Verifier Cache Fix

• Add test for duplicate rangeproof inflation bug ([DNM] Rewind bad block (#3600) #3602
• never speak of the verifier cache again (Remove verifier cache entirely #3628)
• Removing verifier caches (Removing verifier caches #3597)

Fee Structure

• override old accept_fee_base setting of 1000000 to new default 500000 (override old accept_fee_base setting of 1000000 to new default 500000 #3539)

Archival Sync

• Enable block archival sync (Enable block archival sync #3579)
• cleanup redundant sync_head and associated MMR (Retire sync head (and sync MMR) #3556)
• add BLOCK_HIST capabilities on startup if config archive_mode=true (BLOCK_HIST capability enabled if archive_mode=true #3563)
• inc quietly on small batches of headers (inc quietly on small batches of headers #3564)
• add rate limiting to outbound p2p msg sending (add rate limiting to outbound p2p msg sending #3560)

Other Sync Improvements

• client invalidateheader and resetchainhead (client invalidateheader and resetchainhead #3618)
• track sync_head on header_sync sync status (track sync_head on header_sync sync status #3626)
• more consistent handling of peers_preferred during startup (more consistent handling of peers_preferred and peer_allow during startup #3578)
• Block sync hash traversal perf (Block sync hash traversal perf #3558)
• prefer outbound peers when syncing (consistently) (prefer outbound peers when syncing #3521)

Dependencies & Infrastructure

• Add migration to config_file_version = 2 (Add migration to config_file_version = 2 #3634)
• Update zip dependency and fix deprecation warnings (Update zip dependency and fix deprecation warnings #3617)
• Fix Windows CI cargo test silently passing (Fix Windows CI cargo test silently passing #3632)
• Update ring to v0.16.20 (Update ring to v0.16.20 #3612)
• Defork croaring (Defork croaring #3596)
• Update copyright year to 2021 (Update copyright year to 2021 #3592)
• Remove imports and cleanups (Remove imports and cleanups #3590)
• Remove unused imports (Remove unused imports #3589)
• Update and do not use serde private export (Update and do not use serve private export #3585)
• Update Client to v2 API (Update Client to v2 API #3582)
• Update Tokio, hyper versions (Update Tokio, hyper versions #3580)
• Update grin-secp256k1zkp to 0.7.10 (Update grin-secp256k1zkp to 0.7.10 #3581)
• Update to cursive 0.16 (Update to cursive 0.16 #3547)
• Downgrade CI VM to Ubuntu 18.04 (Downgrade CI VM to Ubuntu 18.04 #3535)

Miscellaneous

• fix share difficulty validation - compare stratum server minimum_share_difficulty as unscaled difficulty (fix share difficulty validation - compare stratum server minimum_share_difficulty as unscaled difficulty #3624)
• enhance comment describing how a pow is hashed (enhance comment describing how a pow is hashed #3623)
• cleanup and stop wrapping errors in other/unfit (cleanup and stop wrapping errors in other/unfit #3616)
• Revert "Allow rest api to shutdown (Allow rest api to shutdown #3614)" (Revert "Allow rest api to shutdown" #3625)
• Remove unnecessary trailing semicolon (Remove unnecessary trailing semicolom #3619)
• Allow rest api to shutdown (Allow rest api to shutdown #3614)
• Make of this what you will but it cargo fmt better (Make of this what you will but it cargo fmt better #3572)
• fix for missing increment of stratum stats blocks_found (fix for missing increment of stratum stats blocks_found #3593)
• Mining tui updates (Mining tui updates #3584)
• no more conversion to support v2 blocks (retire support for v2 blocks #3587)
• Fix PIBD segments ([5.0.x] Fix PIBD segments #3532) (Fix PIBD segments #3583)
• Prune list iterators (Prune list iterators #3574)
• optimization for reading peak hashes from backend file (optimization for reading peak hashes from backend file #3575)
• replace subtree with pruned root (replace subtree with pruned root #3576)
• Retire pruned cache (Retire pruned cache #3573)
• Refactor prune file replace (Refactor prune file replace #3571)
• inefficient locking on recv of peers lists can result in failure to get peers lock ([5.0.x] inefficient locking on recv of peers lists can result in failure to get peers lock #3566) (inefficient locking on recv of peers lists can result in fail… #3570)
• pibd capabilities test was only relevant temporarily (pibd capabilities test was only relevant temporarily (while not enabled by default) #3565)
• fix for missing block under certain startup conditions (fix for missing block under certain startup conditions #3555)
• Safety: check length during deserialization (Safety: check length during deserialization #3551)
• remove unused function (remove unused function #3509)
• Block migration db flag (only migrate once) (Block migration db flag (only migrate once) #3512)

[briancolecoinmetrics]

Is there any chance that release notes could be included in the actual release on github, and/or in a CHANGELOG.md in the repo, in the future? Github issues are an unintuitive place to look for release notes.

[phyro]

@briancolecoinmetrics thanks for the suggestion. I think we could introduce the CHANGELOG.md, I'll entertain the idea of doing this.
Btw, we usually have some log here as well https://github.com/mimblewimble/grin/releases/tag/v5.1.0 but it's not really as structure as the one above.

[briancolecoinmetrics]

Sweet, thank you:)

Yeah, I actually hesitated to ask because the release page has something already, but this is much more readable.