From 05971d07e3cc38e9764c88ccea78c307710241fb Mon Sep 17 00:00:00 2001 From: Chanhyuck Ko Date: Fri, 27 Oct 2023 19:00:14 +0900 Subject: [PATCH] docs: update CHANGES.md --- CHANGES.md | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index ec4fd2caaeb..93cb7bc1d17 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,113 @@ Libplanet changelog =================== +Version 4.0.0 +------------- + +To be released. + +### Deprecated APIs + +### Backward-incompatible API changes + + - Removed `BlockChainStates` class. [[#TBD]] + - (Libplanet.Action) Changed `ActionEvaluator` to accept `IWorld` + instead of `IAccount`. [[#TBD]] + - (Libplanet.Action) `IActionEvaluator.OutputState` became `IWorld`. + (was `IAccount`) [[#TBD]] + - (Libplanet.Action) Added + `ActionEvaluationsExtensions.GetLegacyRawTotalDelta()` extension method. + [[#TBD]] + - (Libplanet.Action) `ActionEvaluationsExtensions.GetRawTotalDelta()` + became to return + `IImmutableDictionary>`. + [[#TBD]] + - (Libplanet.Action) `IAction.Execute()` became to return `IWorld`. + (was `IAccount`) [[#TBD]] + - (Libplanet.Action) `IActionContext.PreviousState` became `IWorld`. + (was `IAccount`) [[#TBD]] + - (Libplanet.Action) Following methods in `IFeeCollector` interface + became to accept and return `IWorld`. (was `IAccount`) [[#TBD]] + - `IFeeCollector.Mortgage()` + - `IFeeCollector.Refund()` + - `IFeeCollector.Reward()` + - (Libplanet.Action) Renamed `AccountState` class to `AccountBaseState`. + [[#TBD]] + - (Libplanet.Action) `IBlockChainStates` interface has modified. [[#TBD]] + - Added `IBlockChainStates.GetWorldState()` method. + - Added `IBlockChainStates.GetAccountState(Address, BlockHash?)` method. + - Added `IBlockChainStates.GetState(Address, Address, BlockHash?)` method. + - Added `IBlockChainStates.GetState(Address, HashDigest?)` method. + - Added `IBlockChainStates.GetBalance(Address, Currency, Address, BlockHash?)` method. + - Added `IBlockChainStates.GetBalance(Address, Currency, HashDigest?)` method. + - Added `IBlockChainStates.GetTotalSupply(Currency, Address, BlockHash?)` method. + - Added `IBlockChainStates.GetTotalSupply(Currency, HashDigest?)` method. + - Added `IBlockChainStates.GetValidatorSet(Address, BlockHash?)` method. + - Added `IBlockChainStates.GetValidatorSet(HashDigest?)` method. + - Removed `IBlockChainStates.GetAccountState(BlockHash?)` method. + - Removed `IBlockChainStates.GetState(Address, BlockHash?)` method. + - Removed `IBlockChainStates.GetStates(IReadOnlyList
, BlockHash?)` method. + - Removed `IBlockChainStates.GetBalance(Address, Currency, BlockHash?)` method. + - Removed `IBlockChainStates.GetTotalSupply(Currency, BlockHash?)` method. + - Removed `IBlockChainStates.GetValidatorSet(BlockHash?)` method. + - (Libplanet.Action) `Initialize.Initialize()` method became to accept + `IImmutableDictionary>`. + (was `IImmutableDictionary`) [[#TBD]] + - (Libplanet.Action) Type of `Initialize.States` property became + `IImmutableDictionary>?`. + (was `IImmutableDictionary?`) [[#TBD]] + + +### Backward-incompatible network protocol changes + +### Backward-incompatible storage format changes + +### Added APIs + + - (Libplanet.Action) Added `IWorld` interface and its implementation. + [[#TBD]] + - Added `World` class. + - (Libplanet.Action) Added `IWorldDelta` interface. [[#TBD]] + - (Libplanet.Action) Added `IWorldState` interface and its implementation. + [[#TBD]] + - Added `WorldBaseState` class. + - (Libplanet.Action) Added `KeyConverters` static class. [[#TBD]] + - (Libplanet.Action) Added `ReservedAddresses` static class. [[#TBD]] + - (Libplanet.Action) Added `WorldDeltaExtensions` static class. [[#TBD]] + - (Libplanet.Explorer) Added `AccountStateType` class. [[#TBD]] + - (Libplanet.Explorer) Added `WorldStateType` class. [[#TBD]] + - (Libplanet.Explorer) Added `WorldStateType` class. [[#TBD]] + - (Libplanet.Explorer) Modified some fields of `StateQuery` query. [[#TBD]] + - Added `StateQuery.worldState` field. + - Added `StateQuery.accountState` field. + - Added `accountAddress` of type `Address` argument + for `StateQuery.states` field. + - Added `accountStateRootHash` of type `HashDigest?` argument + for `StateQuery.states` field. + - Added `accountAddress` of type `Address` argument + for `StateQuery.balance` field. + - Added `accountStateRootHash` of type `HashDigest?` argument + for `StateQuery.balance` field. + - Added `accountAddress` of type `Address` argument + for `StateQuery.totalSupply` field. + - Added `accountStateRootHash` of type `HashDigest?` argument + for `StateQuery.totalSupply` field. + - Added `accountAddress` of type `Address` argument + for `StateQuery.validators` field. + - Added `accountStateRootHash` of type `HashDigest?` argument + for `StateQuery.validators` field. + +### Behavioral changes + +### Bug fixes + +### Dependencies + +### CLI tools + +[#TBD]: https://github.com/planetarium/libplanet/pull/TBD + + Version 3.7.0 -------------