Added changelog for v3.0.0-beta1.

Added info about changes in GetDeploy() response.

Signed-off-by: David Hernando <[email protected]>

Author: davidatwhiletrue

CHANGELOG.md

@@ -9,6 +9,54 @@ All notable changes to this project will be documented in this file.  The format
 [comment]: <> (Fixed:      any bug fixes)
 [comment]: <> (Security:   in case of vulnerabilities)
 
+## [3.0.0-beta1]
+
+This version is compatible with Casper node v2.0.0-rc3 and Casper node v1.5.6.
+
+### Added
+
+* New `GetEntity()` method added to the RPC client.
+* New `QueryBalanceDetails()` method added to the RPC client.
+* New `PutTransaction()` and `GetTransaction()` methods added to the RPC client.
+* New `TransactionV1` class to model the new type of transactions in Condor.
+* New global state keys added to the SDK: `AddressableEntityKey`, `BalanceHoldKey`, `BidAddrKey`, `BlockGlobalAddrKey`, `ByteCodeKey`, `EntryPointKey`, `MessageKey`, `NamedKeyKey` and `PackageKey`.
+* New `AddressableEntity` class added. It may represent an account, a stored smart contract, or a system smart contract.
+* New properties in the `StoredValue` class that can be retrieved with `QueryGlobalState()` method: `BidKind`, `Unbonding`, `AddressableEntity`, `Package`, `ByteCode`, `MessageTopicSummary`, `Message`, `NamedKey`, `Reservation`, and `EntryPoint`.
+* New classes to represent data from the global state: `BidKind`, `UnbondingPurse`, `Package` and `ByteCode`.
+* New `Message` class to contain data for native events included in the `TransactionAccepted` event from the SSE channel.
+* Added `TransactionAccepted`, `TransactionProcessed`, and `TransactionExpired` events to the list of events emitted by a node through the SSE interface.
+
+### Changed
+
+* The `Block` class has changed to abstract the developer from the versioned block records returned from the network in Condor version. Refer to the migration guide for more information. 
+* For blocks produced in Casper 2.0, the `Block` instance contains the previous switch block hash in the `LastSwitchBlockHash` property.
+* Ther `EraEnd` class has changed to abstract the developer from the versioned records returned from the network. More info in the migration guide. 
+* The `Transfer` class contained in the response for a `GetBlockTransfers()` call or in a `ExecutionResult` object has changed to abstract from the versioned transfer records returned from the network. Refer to the migration guide for more information.
+* The input argument for the `QueryBalance()` method in the RPC client is any object from a class implementing the `IPurseIdentifier` interface. `PublicKey`, `AccountHashKey`, `URef`, and `AddressableEntity` classes implement this interface.
+* The type to refer to block heights is now `ulong` across all the SDK. In previous version there was a mix of `ulong` and `int`. 
+* When using the `GetNodeStatus()` method with a Casper 2.0 node, the response contains the hash for the latest switch block in the `LatestSwitchBlockHash` property.
+* `GetDeploy()` response has changed and now contains a `ExecutionInfo`object when the deploy has been processed instead a list of `ExecutionResult` objects. The execution info itself contains block information and a result object. 
+* Starting with this version of the SDK, only public keys are checksummed with the CEP-57 standard. The rest of the keys and hashes are not checksummed anymore. 
+* In the `StoredValue` class, `Transfer` has been renamed to `LegacyTransfer`.
+* `DeployApproval` class has been renamed to `Approval` and is used for `Deploy` as well as for the new `TransactionV1` model. 
+* `ActionThresholds` class has now new `UpgradeManagement` property.
+* The `EntryPoint` class has new entry point types and a new property `EntryPointPayment`. Both apply when working with Casper 2.0 only.
+* `Step` event from SSE contains a list of `Transform` objects instead of a `ExecutionEffect` instance.
+* `FinalitySignature` event contains `BlockHeight` and `ChainNameHash` value when connected to a Casper 2.0 node. 
+* `DeployProcessed` event from SSE contains a `ExecutionResultV1` object instead of a `ExecutionResult` object.
+
+### Deprecated
+
+* `Proposer.isSystem` property is marked as Obsolete. Use `IsSystem` with capital `I` instead.
+
+### Removed
+
+* `GetAccountBalance()` method in the RPC client has been removed. Use `QueryBalance()` instead. `GetBalance()` method exists to use `state_get_balance` from the RPC interface if needed.
+
+### Security
+
+* BouncyCastle package updated to 2.4.0 version.
+
 ## [2.3.0]
 
 ### Added
@@ -83,6 +131,7 @@ This new type permits to parse correctly the value `"00"` used for system blocks
 ### Added
 * Initial release of Casper .NET SDK.
 
+[3.0.0-beta1]: https://github.com/make-software/casper-net-sdk/releases/tag/v3.0.0-beta1
 [2.3.0]: https://github.com/make-software/casper-net-sdk/releases/tag/v2.3.0
 [2.2.0]: https://github.com/make-software/casper-net-sdk/releases/tag/v2.2.0
 [2.1.0]: https://github.com/make-software/casper-net-sdk/releases/tag/v2.1.0

Docs/Articles/CondorMigrationGuide.md

@@ -97,7 +97,7 @@ version. That's not the case with Casper .NET SDK v3.
 
 ## Transfers
 
-The response in `GetBlockTransfers()` method contains a list of `Transfer` objects. This is also a versioned object. It contains all the information related to the information.
+The `Transfer` class contained in the response for a `GetBlockTransfers()` call or in a `ExecutionResult` object is also a versioned object. It contains all the information related to the transfer.
 
 If you need to recover the original format, cast an instance to a `TransferV1` or `TransferV2` object:
 
@@ -161,6 +161,11 @@ Similar to the `DeployTemplates` class, which provides deploy templates for most
 
 Use the new method `PutTransaction` to send a `TransactionV1` to the network. Use the new `GetTransaction` method to retrieve an accepted transaction. Both methods can also be used to send and retrieve a Deploy. For unprocessed transactions, the ExecutionInfo in the response is `null`. Upon processing, this property contains all information about the execution, including cost, payments, errors (if any), and execution effects.
 
+
+### GetDeploy()
+
+Response from the `GetDeploy()` method has changed. Instead of a list of `ExecutionResult` objects, it now returns an instance of `ExecutionInfo` for a processed deploy. This instance contains block information and a results object.
+
 ### Payments and costs
 
 For a transaction (old and new versions) processed in Condor, the execution results object contains three properties related to the gas consumed and the CSPR tokens paid: