From 5f5ba47917646301556fb1b277ef4b6c30ea82f7 Mon Sep 17 00:00:00 2001 From: ilgyu Date: Tue, 23 Jul 2024 23:12:55 +0900 Subject: [PATCH] document: Update changelog --- CHANGES.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 81cb6a9992..9dab7398ac 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -8,10 +8,13 @@ To be released. ### Deprecated APIs - - `ValidatorSet.GetProposer()` has been removed. [[#VRF]] + - `ValidatorSet.GetProposer()` has been removed. [[#3895]] ### Backward-incompatible API changes + - `BlockMetadata.CurrentProtocolVersion` has been changed from 9 to 10. + [[#3895]] + ### Backward-incompatible network protocol changes ### Backward-incompatible storage format changes @@ -20,40 +23,38 @@ To be released. - Added `IConsensusCryptoBackend` interface, which contains VRF functionalities which is used on the consensus as a pseudo-random function. - [[#VRF]] + [[#3895]] - Added `DefaultConsensusCryptoBackend` class as a default implementation of - `IConsensusCryptoBackend`. [[#VRF]] + `IConsensusCryptoBackend`. [[#3895]] - Added `CryptoConfig.ConsensusCryptoBackend` property as a VRF backend used - on the consensus. [[#VRF]] - - Added `PrivateKey.Prove()` method as a proof generation. [[#VRF]] - - Added `PublicKey.VerifyProof()` method as a proof verification. [[#VRF]] + on the consensus. [[#3895]] + - Added `PrivateKey.Prove()` method as a proof generation. [[#3895]] + - Added `PublicKey.VerifyProof()` method as a proof verification. [[#3895]] - Added `Proof` struct as a wrapper structure of proof(pi-bytes) generated by - ECVRF. [[#VRF]] + ECVRF. [[#3895]] - Added `ConsensusInformation` struct as a base payload to be proved - with private key. [[#VRF]] - - `BlockMetadata.CurrentProtocolVersion` has been changed from 5 to 6. - [[#VRF]] - - Added `IBlockMetadata.Proof` property. [[#VRF]] + with private key. [[#3895]] + - Added `IBlockMetadata.Proof` property. [[#3895]] - Added `Lot` class as a content of message that submits a `Proof` - to be a proposer candidate during `ConsensusStep.Sortition`. [[#VRF]] + to be a proposer candidate during `ConsensusStep.Sortition`. [[#3895]] - Added `DominantLot` class as a content of message that submits a vote for - dominant `Lot` during `ConsensusStep.Sortition`. [[#VRF]]` - - Added `ConsensusStep.Sortition`. [[#VRF]] + dominant `Lot` during `ConsensusStep.Sortition`. [[#3895]]` + - Added `ConsensusStep.Sortition`. [[#3895]] - Added `LotGatherSecond`, `SortitionSecondBase`, `SortitionMultiplier` - to `ContestTimeoutOption`. [[#VRF]] + to `ContestTimeoutOption`. [[#3895]] - Added `ConsensusLotMsg` class as a `ConsensusMsg` broadcasted during - `ConsensusStep.Sortition`. [[#VRF]] + `ConsensusStep.Sortition`. [[#3895]] - Added `ConsensusDominantLotMsg` class as a `ConsensusMsg` broadcasted during - `ConsensusStep.Sortition`. after lot gathering delay. [[#VRF]] - - Added `LotSet` class as a `Lot` and `DominantLot` selector. [[#VRF]] + `ConsensusStep.Sortition`. after lot gathering delay. [[#3895]] + - Added `LotSet` class as a `Lot` and `DominantLot` selector. [[#3895]] ### Behavioral changes - `ActionEvaluator.EvaluateActions()` use `Proof.Seed` as a initial random seed instead of `PreEvaluationHash`, `signature` combined seed. - [[#VRF]] - - Proposer selection is now based on the VRF result. [[#VRF]] - - Consensus now starts with `ConsensusStep.Sortition`. [[#VRF]]` + [[#3895]] + - Proposer selection is now based on the VRF result. [[#3895]] + - Consensus now starts with `ConsensusStep.Sortition`. [[#3895]]` ### Bug fixes @@ -61,7 +62,7 @@ To be released. ### CLI tools -[#VRF]: https://github.com/planetarium/libplanet/pull/TBD +[#3895]: https://github.com/planetarium/libplanet/pull/3895 Version 5.2.0