test RpcServer.Utilities, .SmartContract and .Wallet (#3461)

* test RpcServer.Utilities * test invoke function and script * TestTraverseIterator * TestGetUnclaimedGas * RpcServerSettings.Default with { SessionEnabled = true } * test call with storage changes and events * use wallet in invokefunction * use invalid wallet * invoke without signer * all cases for TraverseIterator * traversing same session twice; not expired session * cover OnTimer * test deserializing complex signers * use Assert.ThrowsException * TestSendFrom and TestSendMany * apply code review with `nameof` * test cancel transaction * TestInvokeContractVerify * improve error message --------- Co-authored-by: Shargon <[email protected]> Co-authored-by: NGD Admin <[email protected]>
neo-project · Aug 23, 2024 · 436906c · 436906c
1 parent 71da68d
commit 436906c
Show file tree

Hide file tree

Showing 8 changed files with 411 additions and 7 deletions.
diff --git a/src/Plugins/RpcServer/RpcErrorFactory.cs b/src/Plugins/RpcServer/RpcErrorFactory.cs
@@ -33,7 +33,7 @@ public static RpcError NewCustomError(int code, string message, string data = nu
         public static RpcError BadRequest(string data) => RpcError.BadRequest.WithData(data);
         public static RpcError InsufficientFundsWallet(string data) => RpcError.InsufficientFundsWallet.WithData(data);
         public static RpcError VerificationFailed(string data) => RpcError.VerificationFailed.WithData(data);
-        public static RpcError InvalidContractVerification(UInt160 contractHash) => RpcError.InvalidContractVerification.WithData($"The smart contract {contractHash} haven't got verify method.");
+        public static RpcError InvalidContractVerification(UInt160 contractHash, int pcount) => RpcError.InvalidContractVerification.WithData($"The smart contract {contractHash} haven't got verify method with {pcount} input parameters.");
         public static RpcError InvalidContractVerification(string data) => RpcError.InvalidContractVerification.WithData(data);
         public static RpcError InvalidSignature(string data) => RpcError.InvalidSignature.WithData(data);
         public static RpcError OracleNotDesignatedNode(ECPoint oraclePub) => RpcError.OracleNotDesignatedNode.WithData($"{oraclePub} isn't an oracle node.");

diff --git a/src/Plugins/RpcServer/RpcServer.SmartContract.cs b/src/Plugins/RpcServer/RpcServer.SmartContract.cs
@@ -39,7 +39,7 @@ private void Initialize_SmartContract()
                 timer = new(OnTimer, null, settings.SessionExpirationTime, settings.SessionExpirationTime);
         }
 
-        private void Dispose_SmartContract()
+        internal void Dispose_SmartContract()
         {
             timer?.Dispose();
             Session[] toBeDestroyed;
@@ -52,7 +52,7 @@ private void Dispose_SmartContract()
                 session.Dispose();
         }
 
-        private void OnTimer(object state)
+        internal void OnTimer(object state)
         {
             List<(Guid Id, Session Session)> toBeDestroyed = new();
             lock (sessions)

diff --git a/src/Plugins/RpcServer/RpcServer.Utilities.cs b/src/Plugins/RpcServer/RpcServer.Utilities.cs
@@ -18,7 +18,7 @@ namespace Neo.Plugins.RpcServer
     partial class RpcServer
     {
         [RpcMethod]
-        protected virtual JToken ListPlugins(JArray _params)
+        protected internal virtual JToken ListPlugins(JArray _params)
         {
             return new JArray(Plugin.Plugins
                 .OrderBy(u => u.Name)
@@ -34,7 +34,7 @@ protected virtual JToken ListPlugins(JArray _params)
         }
 
         [RpcMethod]
-        protected virtual JToken ValidateAddress(JArray _params)
+        protected internal virtual JToken ValidateAddress(JArray _params)
         {
             string address = Result.Ok_Or(() => _params[0].AsString(), RpcError.InvalidParams.WithData($"Invlid address format: {_params[0]}"));
             JObject json = new();

diff --git a/src/Plugins/RpcServer/RpcServer.Wallet.cs b/src/Plugins/RpcServer/RpcServer.Wallet.cs
@@ -494,7 +494,7 @@ private JObject GetVerificationResult(UInt160 scriptHash, ContractParameter[] ar
         {
             using var snapshot = system.GetSnapshotCache();
             var contract = NativeContract.ContractManagement.GetContract(snapshot, scriptHash).NotNull_Or(RpcError.UnknownContract);
-            var md = contract.Manifest.Abi.GetMethod(ContractBasicMethod.Verify, ContractBasicMethod.VerifyPCount).NotNull_Or(RpcErrorFactory.InvalidContractVerification(contract.Hash));
+            var md = contract.Manifest.Abi.GetMethod(ContractBasicMethod.Verify, args.Count()).NotNull_Or(RpcErrorFactory.InvalidContractVerification(contract.Hash, args.Count()));
             (md.ReturnType == ContractParameterType.Boolean).True_Or(RpcErrorFactory.InvalidContractVerification("The verify method doesn't return boolean value."));
             Transaction tx = new()
             {

diff --git a/tests/Neo.Plugins.RpcServer.Tests/UT_RpcServer.SmartContract.cs b/tests/Neo.Plugins.RpcServer.Tests/UT_RpcServer.SmartContract.cs
@@ -0,0 +1,233 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// UT_RpcServer.Wallet.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using FluentAssertions;
+using Microsoft.AspNetCore.Http;
+using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Neo.Cryptography.ECC;
+using Neo.IO;
+using Neo.Json;
+using Neo.Network.P2P.Payloads;
+using Neo.Network.P2P.Payloads.Conditions;
+using Neo.Persistence;
+using Neo.SmartContract;
+using Neo.SmartContract.Native;
+using Neo.UnitTests;
+using Neo.UnitTests.Extensions;
+using Neo.Wallets;
+using System;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading;
+
+namespace Neo.Plugins.RpcServer.Tests;
+
+public partial class UT_RpcServer
+{
+    static readonly string NeoTotalSupplyScript = "wh8MC3RvdGFsU3VwcGx5DBT1Y\u002BpAvCg9TQ4FxI6jBbPyoHNA70FifVtS";
+    static readonly string NeoTransferScript = "CxEMFPlu76Cuc\u002BbgteStE4ozsOWTNUdrDBQtYNweHko3YcnMFOes3ceblcI/lRTAHwwIdHJhbnNmZXIMFPVj6kC8KD1NDgXEjqMFs/Kgc0DvQWJ9W1I=";
+    static readonly UInt160 ValidatorScriptHash = Contract
+        .CreateSignatureRedeemScript(TestProtocolSettings.SoleNode.StandbyCommittee[0])
+        .ToScriptHash();
+    static readonly string ValidatorAddress = ValidatorScriptHash.ToAddress(ProtocolSettings.Default.AddressVersion);
+    static readonly UInt160 MultisigScriptHash = Contract
+        .CreateMultiSigRedeemScript(1, TestProtocolSettings.SoleNode.StandbyCommittee)
+        .ToScriptHash();
+    static readonly string MultisigAddress = MultisigScriptHash.ToAddress(ProtocolSettings.Default.AddressVersion);
+
+    static readonly JArray validatorSigner = [new JObject()
+    {
+        ["account"] = ValidatorScriptHash.ToString(),
+        ["scopes"] = nameof(WitnessScope.CalledByEntry),
+        ["allowedcontracts"] = new JArray([NeoToken.NEO.Hash.ToString(), GasToken.GAS.Hash.ToString()]),
+        ["allowedgroups"] = new JArray([TestProtocolSettings.SoleNode.StandbyCommittee[0].ToString()]),
+        ["rules"] = new JArray([new JObject() { ["action"] = nameof(WitnessRuleAction.Allow), ["condition"] = new JObject { ["type"] = nameof(WitnessConditionType.CalledByEntry) } }]),
+    }];
+    static readonly JArray multisigSigner = [new JObject()
+    {
+        ["account"] = MultisigScriptHash.ToString(),
+        ["scopes"] = nameof(WitnessScope.CalledByEntry),
+    }];
+
+    [TestMethod]
+    public void TestInvokeFunction()
+    {
+        _rpcServer.wallet = _wallet;
+
+        JObject resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "totalSupply", new JArray([]), validatorSigner, true));
+        Assert.AreEqual(resp.Count, 8);
+        Assert.AreEqual(resp["script"], NeoTotalSupplyScript);
+        Assert.IsTrue(resp.ContainsProperty("gasconsumed"));
+        Assert.IsTrue(resp.ContainsProperty("diagnostics"));
+        Assert.AreEqual(resp["diagnostics"]["invokedcontracts"]["call"][0]["hash"], NeoToken.NEO.Hash.ToString());
+        Assert.IsTrue(((JArray)resp["diagnostics"]["storagechanges"]).Count == 0);
+        Assert.AreEqual(resp["state"], nameof(VM.VMState.HALT));
+        Assert.AreEqual(resp["exception"], null);
+        Assert.AreEqual(((JArray)resp["notifications"]).Count, 0);
+        Assert.AreEqual(resp["stack"][0]["type"], nameof(Neo.VM.Types.Integer));
+        Assert.AreEqual(resp["stack"][0]["value"], "100000000");
+        Assert.IsTrue(resp.ContainsProperty("tx"));
+
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "symbol"));
+        Assert.AreEqual(resp.Count, 6);
+        Assert.IsTrue(resp.ContainsProperty("script"));
+        Assert.IsTrue(resp.ContainsProperty("gasconsumed"));
+        Assert.AreEqual(resp["state"], nameof(VM.VMState.HALT));
+        Assert.AreEqual(resp["exception"], null);
+        Assert.AreEqual(((JArray)resp["notifications"]).Count, 0);
+        Assert.AreEqual(resp["stack"][0]["type"], nameof(Neo.VM.Types.ByteString));
+        Assert.AreEqual(resp["stack"][0]["value"], Convert.ToBase64String(Encoding.UTF8.GetBytes("NEO")));
+
+        // This call triggers not only NEO but also unclaimed GAS
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "transfer", new JArray([
+            new JObject() { ["type"] = nameof(ContractParameterType.Hash160), ["value"] = MultisigScriptHash.ToString() },
+            new JObject() { ["type"] = nameof(ContractParameterType.Hash160), ["value"] = ValidatorScriptHash.ToString() },
+            new JObject() { ["type"] = nameof(ContractParameterType.Integer), ["value"] = "1" },
+            new JObject() { ["type"] = nameof(ContractParameterType.Any) },
+        ]), multisigSigner, true));
+        Assert.AreEqual(resp.Count, 7);
+        Assert.AreEqual(resp["script"], NeoTransferScript);
+        Assert.IsTrue(resp.ContainsProperty("gasconsumed"));
+        Assert.IsTrue(resp.ContainsProperty("diagnostics"));
+        Assert.AreEqual(resp["diagnostics"]["invokedcontracts"]["call"][0]["hash"], NeoToken.NEO.Hash.ToString());
+        Assert.IsTrue(((JArray)resp["diagnostics"]["storagechanges"]).Count == 4);
+        Assert.AreEqual(resp["state"], nameof(VM.VMState.HALT));
+        Assert.AreEqual(resp["exception"], $"The smart contract or address {MultisigScriptHash.ToString()} is not found");
+        JArray notifications = (JArray)resp["notifications"];
+        Assert.AreEqual(notifications.Count, 2);
+        Assert.AreEqual(notifications[0]["eventname"].AsString(), "Transfer");
+        Assert.AreEqual(notifications[0]["contract"].AsString(), NeoToken.NEO.Hash.ToString());
+        Assert.AreEqual(notifications[0]["state"]["value"][2]["value"], "1");
+        Assert.AreEqual(notifications[1]["eventname"].AsString(), "Transfer");
+        Assert.AreEqual(notifications[1]["contract"].AsString(), GasToken.GAS.Hash.ToString());
+        Assert.AreEqual(notifications[1]["state"]["value"][2]["value"], "50000000");
+
+        _rpcServer.wallet = null;
+    }
+
+    [TestMethod]
+    public void TestInvokeScript()
+    {
+        JObject resp = (JObject)_rpcServer.InvokeScript(new JArray(NeoTotalSupplyScript, validatorSigner, true));
+        Assert.AreEqual(resp.Count, 7);
+        Assert.IsTrue(resp.ContainsProperty("gasconsumed"));
+        Assert.IsTrue(resp.ContainsProperty("diagnostics"));
+        Assert.AreEqual(resp["diagnostics"]["invokedcontracts"]["call"][0]["hash"], NeoToken.NEO.Hash.ToString());
+        Assert.AreEqual(resp["state"], nameof(VM.VMState.HALT));
+        Assert.AreEqual(resp["exception"], null);
+        Assert.AreEqual(((JArray)resp["notifications"]).Count, 0);
+        Assert.AreEqual(resp["stack"][0]["type"], nameof(Neo.VM.Types.Integer));
+        Assert.AreEqual(resp["stack"][0]["value"], "100000000");
+
+        resp = (JObject)_rpcServer.InvokeScript(new JArray(NeoTransferScript));
+        Assert.AreEqual(resp.Count, 6);
+        Assert.AreEqual(resp["stack"][0]["type"], nameof(Neo.VM.Types.Boolean));
+        Assert.AreEqual(resp["stack"][0]["value"], false);
+    }
+
+    [TestMethod]
+    public void TestTraverseIterator()
+    {
+        // GetAllCandidates that should return 0 candidates
+        JObject resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "getAllCandidates", new JArray([]), validatorSigner, true));
+        string sessionId = resp["session"].AsString();
+        string iteratorId = resp["stack"][0]["id"].AsString();
+        JArray respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]);
+        Assert.AreEqual(respArray.Count, 0);
+        _rpcServer.TerminateSession([sessionId]);
+        Assert.ThrowsException<RpcException>(() => (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]), "Unknown session");
+
+        // register candidate in snapshot
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "registerCandidate",
+            new JArray([new JObject()
+            {
+                ["type"] = nameof(ContractParameterType.PublicKey),
+                ["value"] = TestProtocolSettings.SoleNode.StandbyCommittee[0].ToString(),
+            }]), validatorSigner, true));
+        Assert.AreEqual(resp["state"], nameof(VM.VMState.HALT));
+        SnapshotCache snapshot = _neoSystem.GetSnapshotCache();
+        Transaction? tx = new Transaction
+        {
+            Nonce = 233,
+            ValidUntilBlock = NativeContract.Ledger.CurrentIndex(snapshot) + _neoSystem.Settings.MaxValidUntilBlockIncrement,
+            Signers = [new Signer() { Account = ValidatorScriptHash, Scopes = WitnessScope.CalledByEntry }],
+            Attributes = Array.Empty<TransactionAttribute>(),
+            Script = Convert.FromBase64String(resp["script"].AsString()),
+            Witnesses = null,
+        };
+        ApplicationEngine engine = ApplicationEngine.Run(tx.Script, snapshot, container: tx, settings: _neoSystem.Settings, gas: 1200_0000_0000);
+        engine.SnapshotCache.Commit();
+
+        // GetAllCandidates that should return 1 candidate
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "getAllCandidates", new JArray([]), validatorSigner, true));
+        sessionId = resp["session"].AsString();
+        iteratorId = resp["stack"][0]["id"].AsString();
+        respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]);
+        Assert.AreEqual(respArray.Count, 1);
+        Assert.AreEqual(respArray[0]["type"], nameof(Neo.VM.Types.Struct));
+        JArray value = (JArray)respArray[0]["value"];
+        Assert.AreEqual(value.Count, 2);
+        Assert.AreEqual(value[0]["type"], nameof(Neo.VM.Types.ByteString));
+        Assert.AreEqual(value[0]["value"], Convert.ToBase64String(TestProtocolSettings.SoleNode.StandbyCommittee[0].ToArray()));
+        Assert.AreEqual(value[1]["type"], nameof(Neo.VM.Types.Integer));
+        Assert.AreEqual(value[1]["value"], "0");
+
+        // No result when traversed again
+        respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]);
+        Assert.AreEqual(respArray.Count, 0);
+
+        // GetAllCandidates again
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "getAllCandidates", new JArray([]), validatorSigner, true));
+        sessionId = resp["session"].AsString();
+        iteratorId = resp["stack"][0]["id"].AsString();
+
+        // Insufficient result count limit
+        respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 0]);
+        Assert.AreEqual(respArray.Count, 0);
+        respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 1]);
+        Assert.AreEqual(respArray.Count, 1);
+        respArray = (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 1]);
+        Assert.AreEqual(respArray.Count, 0);
+
+        // Mocking session timeout
+        Thread.Sleep((int)_rpcServerSettings.SessionExpirationTime.TotalMilliseconds + 1);
+        // build another session that did not expire
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "getAllCandidates", new JArray([]), validatorSigner, true));
+        string notExpiredSessionId = resp["session"].AsString();
+        string notExpiredIteratorId = resp["stack"][0]["id"].AsString();
+        _rpcServer.OnTimer(new object());
+        Assert.ThrowsException<RpcException>(() => (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]), "Unknown session");
+        // If you want to run the following line without exception,
+        // DO NOT BREAK IN THE DEBUGGER, because the session expires quickly
+        respArray = (JArray)_rpcServer.TraverseIterator([notExpiredSessionId, notExpiredIteratorId, 1]);
+        Assert.AreEqual(respArray.Count, 1);
+
+        // Mocking disposal
+        resp = (JObject)_rpcServer.InvokeFunction(new JArray(NeoToken.NEO.Hash.ToString(), "getAllCandidates", new JArray([]), validatorSigner, true));
+        sessionId = resp["session"].AsString();
+        iteratorId = resp["stack"][0]["id"].AsString();
+        _rpcServer.Dispose_SmartContract();
+        Assert.ThrowsException<RpcException>(() => (JArray)_rpcServer.TraverseIterator([sessionId, iteratorId, 100]), "Unknown session");
+    }
+
+    [TestMethod]
+    public void TestGetUnclaimedGas()
+    {
+        JObject resp = (JObject)_rpcServer.GetUnclaimedGas([MultisigAddress]);
+        Assert.AreEqual(resp["unclaimed"], "50000000");
+        Assert.AreEqual(resp["address"], MultisigAddress);
+        resp = (JObject)_rpcServer.GetUnclaimedGas([ValidatorAddress]);
+        Assert.AreEqual(resp["unclaimed"], "0");
+        Assert.AreEqual(resp["address"], ValidatorAddress);
+    }
+}
diff --git a/tests/Neo.Plugins.RpcServer.Tests/UT_RpcServer.Utilities.cs b/tests/Neo.Plugins.RpcServer.Tests/UT_RpcServer.Utilities.cs
@@ -0,0 +1,54 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// UT_RpcServer.Wallet.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using FluentAssertions;
+using Microsoft.AspNetCore.Http;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Neo.IO;
+using Neo.Json;
+using Neo.Network.P2P.Payloads;
+using Neo.SmartContract;
+using Neo.SmartContract.Native;
+using Neo.UnitTests;
+using Neo.UnitTests.Extensions;
+using System;
+using System.IO;
+using System.Linq;
+
+namespace Neo.Plugins.RpcServer.Tests;
+
+public partial class UT_RpcServer
+{
+    [TestMethod]
+    public void TestListPlugins()
+    {
+        JArray resp = (JArray)_rpcServer.ListPlugins([]);
+        Assert.AreEqual(resp.Count, 0);
+        Plugins.Plugin.Plugins.Add(new RpcServerPlugin());
+        resp = (JArray)_rpcServer.ListPlugins([]);
+        Assert.AreEqual(resp.Count, 2);
+        foreach (JObject p in resp)
+            Assert.AreEqual(p["name"], nameof(RpcServer));
+    }
+
+    [TestMethod]
+    public void TestValidateAddress()
+    {
+        string validAddr = "NM7Aky765FG8NhhwtxjXRx7jEL1cnw7PBP";
+        JObject resp = (JObject)_rpcServer.ValidateAddress([validAddr]);
+        Assert.AreEqual(resp["address"], validAddr);
+        Assert.AreEqual(resp["isvalid"], true);
+        string invalidAddr = "ANeo2toNeo3MigrationAddressxwPB2Hz";
+        resp = (JObject)_rpcServer.ValidateAddress([invalidAddr]);
+        Assert.AreEqual(resp["address"], invalidAddr);
+        Assert.AreEqual(resp["isvalid"], false);
+    }
+}