Skip to content

RELEASE_NOTES.md

Latest commit

 

History

History
89 lines (62 loc) · 5.95 KB

RELEASE_NOTES.md

File metadata and controls

89 lines (62 loc) · 5.95 KB

Release Notes

Unreleased

  • Remove Effect::GetValidatorSet, AppMsg::GetValidatorSet and HostMsg::GetValidatorSet (#1189)
  • Introduce malachitebft-signing crate for exposing the SigningProvider and SigningProviderExt traits (#1191)
  • Make SigningProvider trait methods fallible (#1191)
  • Make SigningProvider trait methods async (#1151)
  • Make GossipSub topic names configurable (#849)
  • Fix bug in WAL recovery logic where a corrupted entry would not be detected in some circumstances (#1127)
  • Add facility for app to request a consensus state dump at any time (#1176)
  • Make libp2p protocol names configurable (#1161)
  • Fix mismatched height of WAL entries emitted when processing StartHeight input (#1232)
  • Allow dynamic adjustment of timeout parameters (#1227)
  • Allow providing both the validator set and the timeouts for a height in StartHeight, RestartHeight and ConsensusReady reply (#1227)
  • Remove initial_validator_set and initial_height fields from Params struct (#1190)

0.5.0

July 31st, 2025

  • Update libp2p to v0.56.x (#1124)
  • Rename Effect::RebroadcastVote to Effect::RepublishVote and Effect::RebroadcastRoundCertificate to Effect::RepublishRoundCertificate (#1011)
  • Decouple Host messages from the Consensus actor (#1109)
  • Fix a bug where values synced from other peers were assigned the current node's address instead of their proposer's address (#1141)
  • Buffer sync values for heights higher than current height in consensus and replay when running consensus for those heights (#1149)
  • Add value batching to sync messages (#1070)

0.4.0

July 8th, 2025

  • Add parallel requests for the sync module (#1092)

0.3.1

July 7th, 2025

  • Derive Borsh encoding for all core types, behind a borsh feature flag (#1098)
  • Fixed a bug where the consensus engine would panic when the validator set is empty, now an error is properly emitted in the logs (#1111)
  • When the sync module receives an invalid commit certificate from another peer, it will now drop the associated synced value altogether instead of passing it up to the application (#1112)

0.3.0

June 17th, 2025

  • Removed the VoteSet synchronization protocol, as it is neither required nor sufficient for liveness (#998)
  • Reply to GetValidatorSet is now optional (#990)
  • Clarify and improve the application handling of multiple proposals for same height and round (#833)
  • Prune votes and polka certificates that are from lower rounds than node's locked_round (#1019)
  • Add support for making progress in the presence of equivocating proposals (#1018)
  • Take minimum available height into account when requesting values from peers (#1074)
  • Add peer scoring system to the sync module with customizable scoring strategy (#1072) See the corresponding PR for more details.

0.2.0

April 16th, 2025

  • Add the capability to re-run consensus for a given height (#893)
  • Verify polka certificates (#974)
  • Use aggregated signatures in polka certificates (#915)
  • Improve verification of commit certificates (#974)

0.1.0

April 9th, 2025

This is the first release of the Malachite consensus engine intended for general use. This version introduces production-ready functionality with improved performance and reliability.

Resources

  • The tutorial for building a simple application on top of Malachite using the high-level channel-based API.
  • ADR 003 describes the architecture adopted in Malachite for handling the propagation of proposed values.
  • ADR 004 describes the coroutine effect system used in Malachite. It is relevant if you are interested in building your own engine on top of the core consensus implementation of Malachite.

0.0.1

December 19, 2024

First open-source release of Malachite. This initial version provides the foundational consensus implementation but is not recommended for production use.