Libplanet 0.10.0

Released on October 27, 2020.

Backward-incompatible API changes

• Extracted rendering methods from IAction to IRenderer<T>, which is introduced in this version. From now on, rendering logic needs to be injected from outside through BlockChain<T>.Renderers, rather than IActions knowing how to render themselves. IRenderer<T> also unified BlockChain<T>.TipChanged event, and introduced new events like IActionRenderer<T>.RenderActionError(), IActionRenderer<T>.RenderBlockEnd(), IRenderer<T>.RenderReorg(), and IRenderer<T>.RenderReorgEnd(). [#860, #875, #959, #963]
  • Removed IAction.Render() method, which was replaced by IActionRenderer<T>.RenderAction().
  • Removed IAction.Unrender() method, which was replaced by IActionRenderer<T>.UnrenderAction().
  • Removed BlockChain<T>.TipChanged event, which was replaced by IRenderer<T>.RenderBlock().
  • Removed PolymorphicAction<T>.Render() and Unrender() methods.
  • Removed BlockChain<T>.TipChangedEventArgs class.
• Added methods related fungible asset states to IAccountStateDelta: [#861, #900, #954]
  • UpdatedFungibleAssetsAccounts property
  • MintAsset(Address, Currency, BigInteger) method
  • TransferAsset(Address, Address, Currency, BigInteger) method
  • BurnAsset(Address, Currency, BigInteger) method
  • GetBalance(Address, Currency) method
• Added IAccountStateDelta.StateUpdatedAddresses property in order to distinguish state updates from asset states. [#861, #900]
• Added an optional parameter AccountBalanceGetter accountBalanceGetter to Block<T>.EvaluateActionsPerTx() method. [#861, #900]
• BlockChain<T>.StageTransaction() became to throw InvalidTxGenesisHashException when it takes a Transaction<T> from a heterogeneous BlockChain<T> with a different genesis block. [#796, #878]
• Added renderers optional parameter to BlockChain<T>() constructor. [#883, #959, #963]
• Added BigInteger-typed totalDifficulty parameter to Block<T>() constructor. [#666, #917]
• Added BigInteger-typed previousTotalDifficulty parameter to Block<T>.Mine() static method. [#666, #917]
• Added options optional parameter to Swarm<T>() constructor. [#926]
• ICryptoBackend became to ICryptoBackend<T>. [#932]
• ICryptoBackend.Verify(HashDigest<SHA256>, byte[], PublicKey) became to ICryptoBackend<T>.Verify(HashDigest<T>, byte[], PublicKey) [#932]
• Added ICryptoBackend<T>.Sign(HashDigest<T>, PrivateKey) method. [#932]
• DefaultCryptoBackend became to DefaultCryptoBackend<T>. [#932]
• Added ImmutableArray<byte>-typed preEvaluationHash parameter to BlockHeader constructor. [#931, #935]
• Added HashDigest<SHA256>-typed preEvaluationHash parameter to Block<T>() constructor. [#931, #935]
• Replaced SerializationInfoExtensions.GetValueOrDefault<T>() to SerializationInfoExtensions.TryGetValue<T>(). [#940]
• Added bool append = true option to both BlockChain<T>.MineBlock() overloaded methods. Although this breaks ABI-level backward compatibility (i.e., you need to rebuild your assemblies), still is backward-compatible at API-level as the option is turned on by default. [#946]
• Added int? maxTransactions option to both BlockChain<T>.MineBlock() overloaded methods. Although this breaks ABI-level backward compatibility (i.e., you need to rebuild your assemblies), still is backward-compatible at API-level as the option is turned on by default. [#1037, #1039, #1050]
• Added StateCompleterSet<T>? stateCompleters option to two BlockChain<T>.Append() overloaded methods. Although this breaks ABI-level backward compatibility (i.e., you need to rebuild your assemblies), still is backward-compatible at API-level as the option has the default value (StateCompleterSet<T>.Recalculate). [#946]
• Added CancellationToken cancellationToken = default(CancellationToken) option to BlockChain<T>.MineBlock(Address miner) overloaded method. Although this breaks ABI-level backward compatibility (i.e., you need to rebuild your assemblies), still is backward-compatible at API-level as the option has the default value. [#946]
• Added IImmutableSet<Address> trustedStateValidators = null option to both Swarm<T>.StartAsync() overloaded methods. Although this breaks ABI-level backward compatibility (i.e., you need to rebuild your assemblies), still is backward-compatible at API-level as the option is turned on by default. [#946]
• Removed Peer.AppProtocolVersion property. [#949]
• Removed Peer.IsCompatibleWith() method. [#949]
• Replaced Peer(PublicKey, AppProtocolVersion) constructor with Peer(PublicKey) constructor. [#949]
• Replaced BoundPeer(PublicKey, DnsEndPoint, AppProtocolVersion) constructor with Peer(PublicKey, DnsEndPoint) constructor. [#949]
• Extracted IStore's some methods dedicated to block states into IBlockStatesStore. [#950]
  • ListStateKeys() method.
  • ListAllStateReferences() method.
  • LookupStateReference() method.
  • IterateStateReferences() method.
  • StoreStateReference() method.
  • ForkStateReferences() method.
  • GetBlockStates() method.
  • SetBlockStates() method.
  • PruneBlockStates() method.
• The signature of IStore.LookupStateReference<T>(Guid, string, Block<T>) method was changed to LookupStateReference(Guid, string, long). [#950]
• Added IStateStore-typed stateStore to BlockChain<T> constructor. [#950]
• Replaced Swarm<T>.FindSpecificPeerAsync(Address, Address, int, BoundPeer, TimeSpan?, CancellationToken) method with Swarm<T>.FindSpecificPeerAsync(Address, int, TimeSpan?, CancellationToken). [#981]
• Added IActionContext.GetUnconsumedContext() method. [#980]
• Added ImmutableArray<byte>-typed stateRootHash parameter to BlockHeader constructor. [#986]
• Added HashDigest<SHA256>-typed stateRootHash parameter to Block<T>() constructor. [#986]
• Added IBlockPolicy<T>.MaxTransactionsPerBlock property. [#1037, #1050]
• Added IBlockPolicy<T>.GetMaxBlockBytes() method. [#201, #1050]
• IBlockPolicy<T>.DoesTransactionFollowPolicy() method became to take additional BlockChain<T> parameter as its context. [#1012]
• Methods in BlockPolicy<T> class became virtual. [#1010]
• Added int maxTransactionsPerBlock option to both BlockPolicy<T>() overloaded constructors. [#1037, #1050]
• Added int maxBlockBytes and int maxGenesisBytes options to both BlockPolicy<T>() overloaded constructors. [#201, #1050]
• BlockPolicy<T>() constructor's doesTransactionFollowPolicy parameter became `Func<Transaction, BlockChain...

Libplanet 0.9.5

Released on June 12, 2020.

• Fixed a bug that had not properly received block hashes after the chain had reorged. [#880, #905]

Libplanet 0.9.4

Released on June 2, 2020.

• (Libplanet.RocksDBStore) Fixed a bug that RocksDBStore.DeleteChainId() method had thrown KeyNotFoundException when there's no such chain ID. [#891]
• (Libplanet.RocksDBStore) Fixed a bug that RocksDBStore had written logs into the incorrect context DefaultContext, not RocksDBStore the correct one. [#891]

Libplanet 0.9.3

Released on May 29, 2020.

• Fixed a Swarm<T>.PreloadAsync() method's bug that had hanged in a state downloading block hashes and finally unexpectedly terminated when a peer's chain had gotten reorged. [#880, #884]

Libplanet 0.9.2

Released on May 20, 2020.

• (Libplanet.RocksDBStore) Fixed a memory leak bug in RocksDBStore. [#870]

Libplanet 0.9.1

Released on May 7, 2020.

• Fixed a bug where the canonical chain had changed if any actions had thrown an exception during Swarm<T>.PreloadAsync(). [#862]
• Fixed a Swarm<T>.PreloadAsync() method's bug that it had hung forever and raised InvalidOperationException. [#847, #864]

Libplanet 0.9.0

Released on April 27, 2020.

Backward-incompatible API changes

• BaseStore class became to implement IDisposable. [#789]
• Removed IStore.DeleteIndex(Guid, HashDigest<SHA256>) method. [#802]
• Extension classes was renamed. However, it would not be affected if you have called it by using instance method syntax. [#803]
  • Renamed StunAddressExtension class to StunAddressExtensions.
  • Renamed BytesConvertExtension class to BytesConvertExtensions.
  • Renamed RandomExtension class to RandomExtensions.
  • Renamed AddressExtension class to AddressExtensions.
  • Renamed HashDigestExtension class to HashDigestExtensions.
  • Renamed NetMQFrameExtension class to NetMQFrameExtensions.
  • Renamed NetMQSocketExtension class to NetMQSocketExtensions.
  • Renamed SerializationInfoExtension class to SerializationInfoExtensions.
  • Renamed StoreExtension class to StoreExtensions.
• All parameters, fields, property, and method return values that had been represented as an Int32 became retyped to AppProtocolVersion. [#266, #815]
  • Swarm() constructor's parameter appProtocolVersion became AppProtocolVersion (was Int32).
  • Peer() and BoundPeer() constructors' parameter appProtocolVersion became AppProtocolVersion (was Int32).
  • Peer.AppProtocolVersion property became AppProtocolVersion (was Int32).
  • DifferentProtocolVersionEventArgs.ExpectedVersion and DifferentProtocolVersionEventArgs.ActualVersion properties became AppProtocolVersion (was Int32).
  • Removed DifferentAppProtocolVersionException class.
• Swarm() constructor's EventHandler<DifferentProtocolVersionEventArgs> differentVersionPeerEncountered = null parameter became replaced by DifferentAppProtocolVersionEncountered differentAppProtocolVersionEncountered = null parameter. [#266, #815]
• Added IEnumerable<PublicKey> trustedAppProtocolVersionSigners = null parameter to Swarm() constructor. [#266, #815]
• Removed DifferentProtocolVersionEventArgs class. [#266, #815]
• Removed createdAt parameter from Swarm() constructor. [#838]
• Replaced BlockChain<T>.StageTransactions() with .StageTransaction() that receives only one transaction. [#820]
• Replaced BlockChain<T>.UnstageTransactions() with .UnstageTransaction() that receives only one transaction. [#820]
• Added IBlockPolicy.DoesTransactionFollowPolicy() method which is a method to determine if a transaction follows the block policy. [#827]

Backward-incompatible network protocol changes

• The existing BlockHashes message type (with the type number 0x05) was replaced by a new BlockHashes message type (with type number 0x0e) in order to include an offset block index besides block hashes so that a receiver is able to determine their block indices too. [#707, #798]
• Peer became to have 3 more fields to represent the whole fields of AppProtocolVersion, which is newly introduced. [#266, #815]
• The existing RecentStates message type (with the type number 0x0c) was replaced by a new RecentStates message type (with type number 0x0f) in order to compress its states. [#700, #850]

Backward-incompatible storage format changes

Added APIs

• Added AddressExtensions.ToAddress(this PrivateKey) overloaded extension method. [#825]
• Added BlockHashDownloadState class, a subclass of PreloadState. [#707, #798]
• Added BlockVerificationState class, a subclass of PreloadState. [#798]
• Added AppProtocolVersion struct. [#266, #815]
• Added IKeyStore interface. [#831]
• Added Web3KeyStore class. [#831]
• Added BlockDigest struct. [#785]
• Added BlockHeader struct. [#785]
• Added IStore.GetBlockDigest(HashDigest<SHA256>) method. [#785]
• Added Block<T>.ToBlockDigest() method. [#785]
• Added ByteArrayExtensions class. [#803]
• Added IStore.PruneBlockStates<T>(Guid, Block<T>) method. [#790]
• Added DifferentAppProtocolVersionEncountered delegate. [#266, #815]
• Added Swarm<T>.TrustedAppProtocolVersionSigners property. [#266, #815]
• Added Peer.IsCompatibleWith() method. [#266, #815]
• Added TxViolatingBlockPolicyException class. [#827]
• Added KeyStoreException class. [#831]
• Added NoKeyException class. [#831]

Behavioral changes

• BlockChain.MineBlock() method became to ignore transactions having lower nonce than the expected nonce in the chain. [#791]
• Swarm<T>.PreloadAsync() and Swarm<T>.StartAsync() became to download only a list of block hashes first and then download blocks from simultaneously multiple peers. [#707, #798]
• Improved performance of Swarm<T> by preventing unnecessary task creation. [#817, #837]
• Improved performance of Swarm<T>.PreloadAsync() by parallelizing connections. [#846]
• Improved response throughput of Swarm<T>. [#849]

Bug fixes

• Swarm<T> became not to sync the same Block<T>s or Transaction<T>s multiple times. [#784]
• Fixed a Swarm<T>'s bug that had broadcasted a message to its source peer when the number of peers is not enough (less than the minimum number). [#788]
• Fixed a bug where BlockChain.MineBlock() had produced an invalid block when there is any staged transaction which has lower nonce than the expected nonce, that means, shares an already taken nonce by the same signer. [#791]
• Fixed a Swarm<T>.PreloadAsync() method's bug that temporary chain IDs in the store had been completely cleaned up in some corner cases if cancellationToken was requested. [#798]
• Fixed a bug where Swarm<T> had crashed if it received invalid Transaction<T> from the nodes. [#820]
• Fixed a bug where Swarm<T> hadn't reported IProgress<PreloadState>s correctly.[#839]
• Fixed a Swarm<T>.PreloadAsync() method's bug that it had hung forever when a block failed to be fetched due to an unexpected inner exception. [#839]
• Fixed a bug where actions had been evaluated twice when receiving blocks. [#843, #844]
• Fixed OverflowException being thrown when a passphrase containing any non-ASCII characters was passed to Pbkdf2.Derive() method or ProtectedPrivateKey.Protect() method. [#845]

CLI tools

• Added the planet command and its alias dotnet planet.

Libplanet 0.8.0

Released on February 4, 2020.

Backward-incompatible API changes

• The internal representation for state keys became string (was Address). [#368, #774]
  • The return type of IStore.GetBlockStates() method became IImmutableDictionary<string, IValue> (was AddressStateMap, which was removed too). [#368, #774]
  • The type of the second parameter of IStore.SetBlockStates() method became IImmutableDictionary<string, IValue> (was AddressStateMap, which was removed too). [#368, #774]
  • The second parameter of IStore.IterateStateReferences() method became string key (was Address address). [#368, #774]
  • The second parameter of IStore.StoreStateReference() method became IImmutableSet<string> keys (was IImmutableSet<Address> addresses). [#368, #774]
  • IStore.ListAddresses() method was replaced by IStore.ListStateKeys() method. [#368, #774]
• Added Swarm<T>.FindSpecificPeer() method to find a specific peer given the address. [#570, #580]
• Removed LiteDBStore class. Use DefaultStore instead. [#662]
• Removed BlockChain<T>.Contains(TxId) method. Use IStore.ContainsTransaction(TxId) instead. [#676]
• Renamed BlockChain<T>.Contains(HashDigest<SHA256>) method to BlockChain<T>.ContainsBlock(HashDigest<SHA256>). [#678]
• Removed BlockChain<T>.Contains(Block<T>) method. [#678]
• Changed semantics of BlockChain<T>.ContainsBlock(HashDigest<SHA256>) method and BlockChain<T>[HashDigest<SHA256>] indexer as lookups only the current chain, not entire storage. [#678]
• Added IStore.ContainsBlock(HashDigest<SHA256>) method. [#678]
• Removed AddressStateMap class. [#98, #368, #692, #774]
  • The return type of BlockChain<T>.GetState() method became IValue (was AddressStateMap).
  • The return type of IStore.GetBlockStates() method became IImmutableDictionary<string, IValue> (was AddressStateMap).
  • IStore.SetBlockStates() method became to take IImmutableDictionary<string, IValue> instead of AddressStateMap.
• Swarm<T>.PreloadAsync() method and Swarm<T>.StartAsync() method became to take preloadBlockDownloadFailed event handler as an argument. [#694]
• Added the genesisBlock parameter to BlockChain<T>() constructor. [#688]
• Removed StateReferenceDownloadState class. [#703]
• Removed BlockStateDownloadState class. [#703]
• Removed TxReceived and BlockReceived AsyncAutoResetEvents from Swarm<T>. [#705, #725]
• Added workers optional parameter into Swarm<T>() constructor. [#613, #727]
• Block<T> class became not to implement ISerializable. [#751]
• Transaction<T> class became not to implement ISerializable. [#751]
• Block<T>.ToBencodex() became to return Bencodex.Types.Dictionary. [#751]
• Transaction<T>.ToBencodex() became to return Bencodex.Types.Dictionary. [#751]
• Removed Block<T>.FromBencodex(byte[]) method. [#751]
• Removed Transaction<T>.FromBencodex(byte[]) method. [#751]
• Block<T>.ToBencodex() became to take no arguments. [#749, #757]
• Removed Swarm<T>.BroadcastBlocks(IEnumerable<Block<T>>) method. [#764]
• StoreExtension.LookupStateReference<T>() method was replaced by IStore.LookupStateReference<T>() method. [#722, #774]

Backward-incompatible network protocol changes

• Added long-typed offset parameter to RecentStates and GetRecentStates messages. [#703]
• Added int-typed iteration parameter to RecentStates message. [#703]
• Added BlockHeaderMessage message. [#764]

Backward-incompatible storage format changes

• The introduced DefaultStore is incompatible at the file-level with the LiteDBStore which had existed. DefaultStore became to take a directory instead of a single file, and it consists of multiple subdirectories and a LiteDB file for indices. [#662, #680]

Added APIs

• Added DefaultStore class to replace LiteDBStore. [#662]
• Added IStore.ListAllStateReferences<T>() method. [#701, #703]
• Added IStore.ListStateKeys() method to replace IStore.ListAddresses() method. [#368, #774]
• Added IStore.LookupStateReference<T>() method to replace StoreExtension.LookupStateReference<T>() method. [#368, #722, #774]
• Added BlockChain<T>.Genesis property. [#688]
• Added BlockChain<T>.MakeGenesisBlock() static method. [#688]
• Added InvalidGenesisBlockException class. [#688]
• Added StateDownloadState class which reports state preloading iteration progress. [#703]
• Added PeerDiscoveryException class which inherits SwarmException class. [#604, #726]
• Added Swarm<T>.Peers property which returns an enumerable of peers in Swarm<T>'s routing table. [#739]
• Added Block<T>.Serialize() method which returns byte[]. [#751]
• Added Transaction<T>.Serialize() method which returns byte[]. [#751]
• Added Block<T>(Bencodex.Types.Dictionary) constructor. [#751]
• Added Transaction<T>(Bencodex.Types.Dictionary) constructor. [#751]
• Added Block<T>.Deserialize(byte[]) method. [#751]
• Added Transaction<T>.Deserialize(byte[]) method. [#751]
• Added StoreExtension.Copy(this IStore, IStore) extension method. [#753]
• Added a HashDigest<SHA256>?-typed TxHash property which digests all transactions in the block to Block<T> class. [#749, #757]
• Added CryptoConfig class. [#758]
• Added ICryptoBackend class. [#758]
• Added DefaultCryptoBackend class. [#758]
• Added Swarm<T>.BroadcastBlock(Block<T>) method. [#764]
• Added Swarm<T>.PeerStates property. [#772]
• Added PeerState class which represents a Peers stat...

Libplanet 0.7.0

Released on November 8, 2019.

Backward-incompatible interface changes

• Renamed minValue/maxValue parameters to lowerBound/upperBound of IRandom.Next() methods. [#555, #558]
• Renamed IStore.IterateIndex() method to IterateIndexes(). [#462, #560]
• Swarm<T> class became to implement IDisposable again and should be disposed to clean up its internal resources. [#485]
• IStore.IterateStateReferences() method became to receive highestIndex, lowestIndex, and limit parameters. [#447, #545]
• Reworked BlockChain<T>.GetStates() into GetState() which takes only one Address instead of IEnumerable<Address>. [#510, #563]
• Types of IAction.PlainValue and states became restricted to Bencodex.Types.IValue. [#541, #552]
  • IAction.LoadPlainValue(IImmutableDictionary<string, object>) method became replaced by LoadPlainValue(IValue).
  • AccountStateGetter became to return IValue, not object.
  • Added BencodexExtension static class.
• Removed BlockChain<T>.Blocks. [#409, #583]
• Removed BlockChain<T>.Transactions. [#409, #583]
• Removed the linger parameter from the Swarm<T>() constructor, and added the waitFor parameter to Swarm<T>.StopAsync() method instead. [#581]
• Removed the dialTimeout parameter from the Swarm<T>() constructor, and added it to Swarm<T>.PreloadAsync() & Swarm<T>.StartAsync() methods. [#581]
• Removed broadcast parameter from BlockChain<T>.MakeTransaction() method. [#609]
• BlockChain<T> does not implement IReadOnlyList<T> anymore. [#630]
  • Added BlockChain<T>.Count property. [#630]
  • Removed BlockChain<T>.LongCount() method. [#630]
  • Removed BlockChain<T>.Validate() method. [#630]
  • Removed BlockChain<T>.GetEnumerate() method. [#630]
  • Removed BlockPolicyExtension.ValidateBlocks() method. [#630]
  • IBlockPolicy<T>.GetNextBlockDifficulty() method became to receive BlockChain<T> instead of IReadOnlyList<Block<<T>>. [#630]
  • IBlockPolicy<T>.ValidateNextBlock() method became to receive BlockChain<T> instead of IReadOnlyList<Block<<T>>. [#630]

Added interfaces

• Added ProtectedPrivateKey class. [#577, #614]
• Added IncorrectPassphraseException class. [#577, #614]
• Added MismatchedAddressException class. [#577, #614]
• Added KeyJsonException abstract class. [#577, #614]
• Added InvalidKeyJsonException class. [#577, #614]
• Added UnsupportedKeyJsonException class. [#577, #614]
• Added ICipher interface. [#577, #614]
• Added Aes128Ctr class. [#577, #614]
• Added IKdf interface. [#577, #614]
• Added Pbkdf2 class. [#577, #614]
• Added Scrypt class. [#642, #654]
• Added BlockChain<T>.LongCount() method. [#575]
• Added BlockChain<T>[HashDigest<T>] indexer. [#409, #583]
• Added BlockChain<T>.Contains(HashDigest<T>) method. [#409, #583]
• Added BlockChain<T>.GetTransaction(TxId) method. [#409, #583]
• Added BlockChain<T>.Contains(TxId) method. [#409, #583]
• Added ByteUtil.Hex(ImmutableArray<byte>) overloaded method. [#614]
• Added BlockChain<T>.Contains(Block<T>) method. [#630]
• Added BlockDownloadState.SourcePeer property. [#636]

Behavioral changes

• Changed to send Pong before updating the message sender to the routing table when Ping is received. [#566]
• Improved performance of StoreExtension.LookupStateReference<T>() method. [#447, #545]
• Added .NET Core 2.2 as a targeted framework. [#209, #561]
• TurnClient.AcceptRelayedStreamAsync() became to ignore disconnected connections. [#469]
• Swarm<T>.PreloadAsync() became to ignore peers with lower tip. [#592]
• Swarm<T> became to validate only stale peers. [#568, #593]
• Swarm<T> became not to check cached peers immediately after removing peers from its routing table. Instead, it checks cached peers periodically. [#608]
• Marked Address and HashDigest as readonly. [#610]
• IceServer.CreateTurnClient() became to throw ArgumentException when received invalid url. [#622]
• Swarm<T> became to update peer table when receiving messages that are not related with Kademlia protocol. [#594, #627]
• Swarm<T> became not to check least recently used peer every time when new peer is fetched. [#627]
• IAction became guaranteed that the given IActionContext.PreviousStates.GetState() never throws IncompleteBlockStatesException. Instead, now it may calculate the incomplete states from the beginning if necessary. [#645]
• IStore.PutBlock<T>() became to do nothing when it takes the Block<T> more than once. [#647]
• Swarm<T>.PreloadAsync() became to try downloading blocks from all neighbor peers, even if any peer among them is unavailable to send blocks. [#636]

Bug fixes

• Fixed a bug where Swarm<T> had tried to update a peer infinitely when the peer is evicted from its table. [#566]
• Fixed a bug where Swarm<T>.AppendBlocksAsync() re-requests blocks that already received when blockchain is empty. [#550, #562]
• Fixed a bug that Swarm<T> had thrown SocketException with a message Operation on non-blocking socket would block. [#405, #485]
• Fixed a bug that accessed all blocks fr...