Merge pull request #94 from make-software/casper-2.0.0

Merge Casper 2.0.0 branch into master

Author: davidatwhiletrue

.github/workflows/push-to-github-registry.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 7.0.x
+        dotnet-version: 8.0.x
     - name: Create nuget package
       run: dotnet pack --configuration Release -o out
     - name: Publish Nuget to GitHub registry

CHANGELOG.md

@@ -9,6 +9,94 @@ 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-beta3]
+
+### Added
+
+* The `TransactionBuilder` now accepts amount as `ulong` type for the `Payment()` method.
+* New `GlobalStateKey.FromValidatorKey()` to get the bid address key of a validator.
+* New `GetNodeVersion()` in the main client class as a convenient method to check node version.
+* New `GetValidatorBid()` method to recover the bid information of a validator.
+
+### Changed
+
+* `MessageKey` contains an `AddressableEntity` property instead of a `HashAddr` to represent the related contract entity.
+* `GetAuctionInfo()` now uses the new `state_get_auction_info_v2` RPC method in Casper 2.0.
+
+### Fixed
+
+* [#99](https://github.com/make-software/casper-net-sdk/issues/99) SSE Listener emits the same event 3 times when listening to EventType.All
+* Fixed the `TransactionV1.ValidateHashes()` method to properly verify the hashes.
+
+## [3.0.0-beta2]
+
+### Added
+
+* Added `GetDelegatorReward` and `GetValidatorReward` methods to the RPC client. [PR#76](https://github.com/make-software/casper-net-sdk/pull/76) and [PR#80](https://github.com/make-software/casper-net-sdk/pull/80).
+* Added `GetStatePackage` method to the RPC client. [PR#82](https://github.com/make-software/casper-net-sdk/pull/82).
+* Added `ProtocolVersion` to Get Node Status RPC response. [PR#77](https://github.com/make-software/casper-net-sdk/pull/77).
+* Added a `TransactionBuilder` to build `TransactionV1` transactions for the different type of invocations ( to mint/auction system contracts, user stored contracts) and session deployments. [PR#79](https://github.com/make-software/casper-net-sdk/pull/79).
+
+### Changed
+
+* The `Transaction` type is now an abstraction for `TransactionV1` and `Deploy` transaction models. [PR#79](https://github.com/make-software/casper-net-sdk/pull/79).
+* Updated `TransactionV1` JSON and bytes serialization in alignment to `casper-node v2.0.0-rc5`. [PR-84](https://github.com/make-software/casper-net-sdk/pull/84) and [PR-85](https://github.com/make-software/casper-net-sdk/pull/85)
+* Updated `MessageKey` key type in alignment to `casper-node v2.0.0-rc5`. [PR-86](https://github.com/make-software/casper-net-sdk/pull/86)
+* `EntryPointPayment.SelfOnly` constant replaced with `EntryPointPayment.DirectInvocationOnly`.[PR#87](https://github.com/make-software/casper-net-sdk/pull/87).
+
+### Fixed
+
+* Fixed a multi-thread bug when using the RPCLoggingHandler in the RPC client class. [PR#81](https://github.com/make-software/casper-net-sdk/pull/81).
+* v3.0.0-beta1 did not parse correctly `Step` event emmitted by nodes in Casper v1.x. [PR#78](https://github.com/make-software/casper-net-sdk/pull/78).
+
+## [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.4.0]
 
 ### Changed
@@ -94,6 +182,9 @@ This new type permits to parse correctly the value `"00"` used for system blocks
 ### Added
 * Initial release of Casper .NET SDK.
 
+[3.0.0-beta3]: https://github.com/make-software/casper-net-sdk/releases/tag/v3.0.0-beta3
+[3.0.0-beta2]: https://github.com/make-software/casper-net-sdk/releases/tag/v3.0.0-beta2
+[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

Casper.Network.SDK.Test/AssertExtensions.cs

@@ -0,0 +1,34 @@
+using NUnit.Framework;
+using Org.BouncyCastle.Utilities.Encoders;
+
+namespace NetCasperTest
+{
+    public static class AssertExtensions
+    {
+        public static void IsHash(string maybeHash)
+        {
+            try
+            {
+                Assert.AreEqual(32, Hex.Decode(maybeHash).Length);
+            }
+            catch
+            {
+                Assert.Fail($"Cannot decode a hash from '{maybeHash}'");
+            }
+        }
+
+        public static void IsValidHex(string maybeHex, uint bytesLength = 0)
+        {
+            try
+            {
+                var bytes = Hex.Decode(maybeHex);
+                if(bytesLength > 0)
+                    Assert.AreEqual(bytesLength, bytes.Length);
+            }
+            catch
+            {
+                Assert.Fail($"Cannot decode hex bytes from '{maybeHex}'");
+            }
+        }
+    }
+}

Casper.Network.SDK.Test/CEP57ChecksumTest.cs

@@ -24,59 +24,6 @@ public void CEP57LongByteArray()
             Assert.AreEqual(longHex.ToLower(), encodedHex);
         }
 
-        [Test]
-        public void CEP57DecodeEncode()
-        {
-            int result;
-
-            var hash = "66B754c5E2981B41D41af39B88C8583bD08EF176eB1a81F56b8F395685805968";
-            var bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            
-            GlobalStateKey key = new HashKey(bytes);
-            Assert.AreEqual($"hash-{hash}", key.ToString());
-
-            hash = "eA1D6C19ccAeb35Ae717065c250E0F7F6Dc64AC3c6494a797E0b33A23CA1f1b9";
-            bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            Assert.AreEqual(hash, CEP57Checksum.Encode(bytes));
-
-            key = new TransferKey(bytes);
-            Assert.AreEqual($"transfer-{hash}", key.ToString());
-
-            hash = "98d945f5324F865243B7c02C0417AB6eaC361c5c56602FD42ced834a1Ba201B6";
-            bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            Assert.AreEqual(hash, CEP57Checksum.Encode(bytes));
-
-            key = new DeployInfoKey(bytes);
-            Assert.AreEqual($"deploy-{hash}", key.ToString());
-
-            hash = "8cf5E4aCF51f54Eb59291599187838Dc3BC234089c46fc6cA8AD17e762aE4401";
-            bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            Assert.AreEqual(hash, CEP57Checksum.Encode(bytes));
-
-            key = new BalanceKey(bytes);
-            Assert.AreEqual($"balance-{hash}", key.ToString());
-
-            hash = "010c3Fe81B7b862E50C77EF9A958a05BfA98444F26f96f23d37A13c96244cFB7";
-            bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            Assert.AreEqual(hash, CEP57Checksum.Encode(bytes));
-
-            key = new BidKey(bytes);
-            Assert.AreEqual($"bid-{hash}", key.ToString());
-
-            hash = "98d945f5324F865243B7c02C0417AB6eaC361c5c56602FD42ced834a1Ba201B6";
-            bytes = CEP57Checksum.Decode(hash, out result);
-            Assert.AreEqual(CEP57Checksum.ValidChecksum, result);
-            Assert.AreEqual(hash, CEP57Checksum.Encode(bytes));
-
-            key = new WithdrawKey(bytes);
-            Assert.AreEqual($"withdraw-{hash}", key.ToString());
-        }
-
         [Test]
         public void CEP57HasChecksum()
         {

Casper.Network.SDK.Test/CLValueJsonDeserializerTest.cs

@@ -191,7 +191,7 @@ public void SerializeU512CLValue()
             var doc = System.Text.Json.JsonDocument.Parse(json);
             Assert.AreEqual(3, doc.RootElement.EnumerateObject().Count());
             Assert.AreEqual("U512", doc.RootElement.GetProperty("cl_type").GetString());
-            Assert.AreEqual("05005550B405", doc.RootElement.GetProperty("bytes").GetString());
+            Assert.AreEqual("05005550b405", doc.RootElement.GetProperty("bytes").GetString().ToLower());
             Assert.AreEqual("24500000000", doc.RootElement.GetProperty("parsed").GetString());
 
             clValue = CLValue.U512(15000000000);
@@ -541,7 +541,7 @@ public void SerializeKeyCLValue()
             Assert.IsNotEmpty(json);
             Assert.IsTrue(json.Contains(@"""cl_type"":""Key"""));
             Assert.IsTrue(json.Contains(@"""bytes"":""08b192"));
-            Assert.IsTrue(json.Contains(@"""parsed"":{""Withdraw"":""withdraw-B192"));
+            Assert.IsTrue(json.Contains(@"""parsed"":{""Withdraw"":""withdraw-b192"));
 
             gsKey = GlobalStateKey.FromString(
                 "uref-e48935c79e96c490c01e1e8800de5ec5f4a857a57db0dcffed1e1e2b5d29b5e4-007");
@@ -550,9 +550,9 @@ public void SerializeKeyCLValue()
             Assert.IsNotEmpty(json);
             Assert.IsTrue(json.Contains(@"""cl_type"":""Key"""));
             Assert.IsTrue(
-                json.Contains(@"""bytes"":""02e48935c79E96C490c01e1E8800dE5Ec5F4A857A57dB0DcFfED1e1E2b5d29b5E407"));
+                json.Contains(@"""bytes"":""02e48935c79e96c490c01e1e8800de5ec5f4a857a57db0dcffed1e1e2b5d29b5e407"));
             Assert.IsTrue(json.Contains(
-                @"""parsed"":{""URef"":""uref-E48935C79E96c490c01e1E8800de5Ec5F4A857A57db0dcffEd1E1E2B5D29b5E4-007"));
+                @"""parsed"":{""URef"":""uref-e48935c79e96c490c01e1e8800de5ec5f4a857a57db0dcffed1e1e2b5d29b5e4-007"));
 
             gsKey = GlobalStateKey.FromString("era-2685");
             clValue = CLValue.Key(gsKey);

Casper.Network.SDK.Test/Casper.Network.SDK.Test.csproj

@@ -32,5 +32,7 @@
         <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
     </ItemGroup>
+    <ItemGroup>
+    </ItemGroup>
 
 </Project>

Casper.Network.SDK.Test/DeployItemByteSerializerTest.cs

@@ -40,7 +40,7 @@ public void StoredContractByHashSerialization()
                 new StoredContractByHashDeployItem(hash.ToHexString(),
                     "counter_inc");
 
-            Assert.AreEqual(CEP57Checksum.Encode(hash.RawBytes), storedContract.Hash);
+            Assert.AreEqual(Hex.ToHexString(hash.RawBytes), storedContract.Hash);
             Assert.AreEqual("counter_inc", storedContract.EntryPoint);
             Assert.IsNotNull(storedContract.RuntimeArgs);
             Assert.AreEqual(0, storedContract.RuntimeArgs.Count);
@@ -71,7 +71,7 @@ public void StoredVersionedContractByHashSerialization()
             var storedContract =
                 new StoredVersionedContractByHashDeployItem(hash.ToHexString(), 1, "counter_inc");
 
-            Assert.AreEqual(CEP57Checksum.Encode(hash.RawBytes), storedContract.Hash);
+            Assert.AreEqual(Hex.ToHexString(hash.RawBytes), storedContract.Hash);
             Assert.AreEqual(1, storedContract.Version);
             Assert.AreEqual("counter_inc", storedContract.EntryPoint);
             Assert.IsNotNull(storedContract.RuntimeArgs);

Casper.Network.SDK.Test/DeployJsonSerializerTest.cs

@@ -12,7 +12,7 @@ public class DeployJsonSerializer
         private string deploy1 = TestContext.CurrentContext.TestDirectory + "/TestData/transfer-deploy.json";
         private string signer1 = "017b8058863Aad49c7b89c77019ceF3a4D863BDf1c0c61499776F94b18465810F7";
         private string signature1 =
-            "012a0c5896aB9D6Cf029268Cf454Ba9D42bcD40Bd909C984890F326739EeF13201d1d2a9a95938B2a966F2E650D1bDd80931F0374e3A92403e025B806Aa1065109";
+            "012a0c5896ab9d6cf029268cf454ba9d42bcd40bd909c984890f326739eef13201d1d2a9a95938b2a966f2e650d1bdd80931f0374e3a92403e025b806aa1065109";
 
         [Test]
         public void LoadDeployFromFileTest()