Skip to content

Commit

Permalink
docs: update CHANGES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
OnedgeLee committed Jun 30, 2023
1 parent a48310c commit 316d7bf
Showing 1 changed file with 32 additions and 29 deletions.
61 changes: 32 additions & 29 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,42 @@ To be released.

### Backward-incompatible API changes

- `Vote.BlockHash` property became `BlockHash` type. (was `BlockHash?`)
[[#3249]]
- `VoteMetadata(long, int, BlockHash?, DateTimeOffset, PublicKey, VoteFlag)`
constructor became
`VoteMetadata(long, int, BlockHash, DateTimeOffset, PublicKey, VoteFlag)`
[[#3249]]
- (Libplanet.Net) Renamed `Step` enum to `ConsensusStep`
to remove ambiguity. [[#3249]]
- (Libplanet.Net) `ConsensusProposalMsg`, `ConsensusPreVoteMsg` and
`ConsensusPreCommitMsg` became to inherit `ConsensusVoteMsg`. [[#3249]]
- (Libplanet.Net) Removed `ConsensusMsg.BlockHash` property. [[#3249]]

### Backward-incompatible network protocol changes

### Backward-incompatible storage format changes

### Added APIs

- Added `Maj23` and its related classes. [[#3249]]
- Added `Maj23` class.
- Added `Maj23Metadata` class.
- (Libplanet.Net) Added `ConsensusMaj23Msg` class.
- Added `VoteSetBits` and its related classes. [[#3249]]
- Added `VoteSetBits` class.
- Added `VoteSetBitsMetadata` class.
- (Libplanet.Net) Added `ConsensusVoteSetBitsMsg` class.
- (Libplanet.Net) Added `VoteSet` class. [[#3249]]
- (Libplanet.Net) Added `HeightVoteSet` class. [[#3249]]
- (Libplanet.Net) Added `ConsensusVoteMsg` abstract class. [[#3249]]
- (Libplanet.Net) Added `InvalidProposalException` class. [[#3249]]
- (Libplanet.Net) Added `InvalidVoteException` class. [[#3249]]
- (Libplanet.Net) Added `InvalidMaj23Exception` class. [[#3249]]
- (Libplanet.Net) Added
`Gossip.PublishMessage(MessageContent, IEnumerable<BoundPeer>)` method.
[[#3249]]

### Behavioral changes

### Bug fixes
Expand All @@ -24,6 +54,8 @@ To be released.

### CLI tools

[#3249]: https://github.com/planetarium/libplanet/pull/3249


Version 2.3.0
-------------
Expand Down Expand Up @@ -72,46 +104,17 @@ Released on June 28, 2023.
- Added `IBlockChainStates.GetState()` interface method. [[#3250]]
- Added `IBlockStates.GetState()` interface method. [[#3250]]
- Changed `IBlockStates` to inherit `IAccountState` interface. [[#3251]]
- `Vote.BlockHash` property became `BlockHash` type. (was `BlockHash?`)
[[#3249]]
- `VoteMetadata(long, int, BlockHash?, DateTimeOffset, PublicKey, VoteFlag)`
constructor became
`VoteMetadata(long, int, BlockHash, DateTimeOffset, PublicKey, VoteFlag)`
[[#3249]]
- (Libplanet.Net) Renamed `Step` enum to `ConsensusStep`
to remove ambiguity. [[#3249]]
- (Libplanet.Net) `ConsensusProposalMsg`, `ConsensusPreVoteMsg` and
`ConsensusPreCommitMsg` became to inherit `ConsensusVoteMsg`. [[#3249]]
- (Libplanet.Net) Removed `ConsensusMsg.BlockHash` property. [[#3249]]

### Added APIs

- Added `IAccountDelta` interface and its default implementation
`AccountDelta` class. [[#3245]]
- Added `Maj23` and its related classes. [[#3249]]
- Added `Maj23` class.
- Added `Maj23Metadata` class.
- (Libplanet.Net) Added `ConsensusMaj23Msg` class.
- Added `VoteSetBits` and its related classes. [[#3206]]
- Added `VoteSetBits` class.
- Added `VoteSetBitsMetadata` class.
- (Libplanet.Net) Added `ConsensusVoteSetBitsMsg` class.
- (Libplanet.Net) Added `VoteSet` class. [[#3249]]
- (Libplanet.Net) Added `HeightVoteSet` class. [[#3249]]
- (Libplanet.Net) Added `ConsensusVoteMsg` abstract class. [[#3249]]
- (Libplanet.Net) Added `InvalidProposalException` class. [[#3249]]
- (Libplanet.Net) Added `InvalidVoteException` class. [[#3249]]
- (Libplanet.Net) Added `InvalidMaj23Exception` class. [[#3249]]
- (Libplanet.Net) Added
`Gossip.PublishMessage(MessageContent, IEnumerable<BoundPeer>)` method.
[[#3249]]

[#3230]: https://github.com/planetarium/libplanet/pull/3230
[#3244]: https://github.com/planetarium/libplanet/pull/3244
[#3245]: https://github.com/planetarium/libplanet/pull/3245
[#3247]: https://github.com/planetarium/libplanet/pull/3247
[#3248]: https://github.com/planetarium/libplanet/pull/3248
[#3249]: https://github.com/planetarium/libplanet/pull/3249
[#3250]: https://github.com/planetarium/libplanet/pull/3250
[#3251]: https://github.com/planetarium/libplanet/pull/3251

Expand Down

0 comments on commit 316d7bf

Please sign in to comment.