Add NefFile.Source (#2605)

neo-project · Sep 23, 2021 · b3b2207 · b3b2207
1 parent 778feed
commit b3b2207
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 10 deletions.
diff --git a/src/neo/SmartContract/Native/NativeContract.cs b/src/neo/SmartContract/Native/NativeContract.cs
@@ -136,6 +136,7 @@ protected NativeContract()
             this.Nef = new NefFile
             {
                 Compiler = "neo-core-v3.0",
+                Source = string.Empty,
                 Tokens = Array.Empty<MethodToken>(),
                 Script = script
             };

diff --git a/src/neo/SmartContract/NefFile.cs b/src/neo/SmartContract/NefFile.cs
@@ -27,7 +27,8 @@ namespace Neo.SmartContract
     │ Magic    │ uint32        │ Magic header                               │
     │ Compiler │ byte[64]      │ Compiler name and version                  │
     ├──────────┼───────────────┼────────────────────────────────────────────┤
-    │ Reserve  │ byte[2]       │ Reserved for future extensions. Must be 0. │
+    │ Source   │ byte[]        │ The url of the source files                │
+    │ Reserve  │ byte          │ Reserved for future extensions. Must be 0. │
     │ Tokens   │ MethodToken[] │ Method tokens.                             │
     │ Reserve  │ byte[2]       │ Reserved for future extensions. Must be 0. │
     │ Script   │ byte[]        │ Var bytes for the payload                  │
@@ -50,6 +51,11 @@ public class NefFile : ISerializable
         /// </summary>
         public string Compiler { get; set; }
 
+        /// <summary>
+        /// The url of the source files.
+        /// </summary>
+        public string Source { get; set; }
+
         /// <summary>
         /// The methods that to be called statically.
         /// </summary>
@@ -76,7 +82,8 @@ public class NefFile : ISerializable
 
         public int Size =>
             HeaderSize +            // Header
-            2 +                     // Reserve
+            Source.GetVarSize() +   // Source
+            1 +                     // Reserve
             Tokens.GetVarSize() +   // Tokens
             2 +                     // Reserve
             Script.GetVarSize() +   // Script
@@ -85,7 +92,8 @@ public class NefFile : ISerializable
         public void Serialize(BinaryWriter writer)
         {
             SerializeHeader(writer);
-            writer.Write((short)0);
+            writer.WriteVarString(Source);
+            writer.Write((byte)0);
             writer.Write(Tokens);
             writer.Write((short)0);
             writer.WriteVarBytes(Script ?? Array.Empty<byte>());
@@ -101,18 +109,13 @@ private void SerializeHeader(BinaryWriter writer)
         public void Deserialize(BinaryReader reader)
         {
             if (reader.ReadUInt32() != Magic) throw new FormatException("Wrong magic");
-
             Compiler = reader.ReadFixedString(64);
-
-            if (reader.ReadUInt16() != 0) throw new FormatException("Reserved bytes must be 0");
-
+            Source = reader.ReadVarString(256);
+            if (reader.ReadByte() != 0) throw new FormatException("Reserved bytes must be 0");
             Tokens = reader.ReadSerializableArray<MethodToken>(128);
-
             if (reader.ReadUInt16() != 0) throw new FormatException("Reserved bytes must be 0");
-
             Script = reader.ReadVarBytes(MaxScriptLength);
             if (Script.Length == 0) throw new ArgumentException($"Script can't be empty");
-
             CheckSum = reader.ReadUInt32();
             if (CheckSum != ComputeChecksum(this)) throw new FormatException("CRC verification fail");
         }
@@ -137,6 +140,7 @@ public JObject ToJson()
             {
                 ["magic"] = Magic,
                 ["compiler"] = Compiler,
+                ["source"] = Source,
                 ["tokens"] = new JArray(Tokens.Select(p => p.ToJson())),
                 ["script"] = Convert.ToBase64String(Script),
                 ["checksum"] = CheckSum

diff --git a/tests/neo.UnitTests/SmartContract/UT_ContractState.cs b/tests/neo.UnitTests/SmartContract/UT_ContractState.cs
@@ -24,6 +24,7 @@ public void TestSetup()
                 Nef = new NefFile
                 {
                     Compiler = nameof(ScriptBuilder),
+                    Source = string.Empty,
                     Tokens = Array.Empty<MethodToken>(),
                     Script = script
                 },

diff --git a/tests/neo.UnitTests/SmartContract/UT_Helper.cs b/tests/neo.UnitTests/SmartContract/UT_Helper.cs
@@ -28,6 +28,7 @@ public void TestGetContractHash()
             var nef = new NefFile()
             {
                 Compiler = "test",
+                Source = string.Empty,
                 Tokens = Array.Empty<MethodToken>(),
                 Script = new byte[] { 1, 2, 3 }
             };

diff --git a/tests/neo.UnitTests/SmartContract/UT_InteropService.NEO.cs b/tests/neo.UnitTests/SmartContract/UT_InteropService.NEO.cs
@@ -108,6 +108,7 @@ public void TestContract_Create()
             var nef = new NefFile()
             {
                 Script = Enumerable.Repeat((byte)OpCode.RET, byte.MaxValue).ToArray(),
+                Source = string.Empty,
                 Compiler = "",
                 Tokens = System.Array.Empty<MethodToken>()
             };
@@ -121,6 +122,7 @@ public void TestContract_Create()
             var script_exceedMaxLength = new NefFile()
             {
                 Script = new byte[NefFile.MaxScriptLength - 1],
+                Source = string.Empty,
                 Compiler = "",
                 Tokens = System.Array.Empty<MethodToken>()
             };
@@ -151,6 +153,7 @@ public void TestContract_Update()
             var nef = new NefFile()
             {
                 Script = new[] { (byte)OpCode.RET },
+                Source = string.Empty,
                 Compiler = "",
                 Tokens = System.Array.Empty<MethodToken>()
             };
@@ -201,6 +204,7 @@ public void TestContract_Update_Invalid()
             var nefFile = new NefFile()
             {
                 Script = new byte[] { 0x01 },
+                Source = string.Empty,
                 Compiler = "",
                 Tokens = System.Array.Empty<MethodToken>()
             };
@@ -215,6 +219,7 @@ public void TestContract_Update_Invalid()
             nefFile = new NefFile()
             {
                 Script = new byte[0],
+                Source = string.Empty,
                 Compiler = "",
                 Tokens = System.Array.Empty<MethodToken>()
             };

diff --git a/tests/neo.UnitTests/SmartContract/UT_NefFile.cs b/tests/neo.UnitTests/SmartContract/UT_NefFile.cs
@@ -13,6 +13,7 @@ public class UT_NefFile
         public NefFile file = new()
         {
             Compiler = "".PadLeft(32, ' '),
+            Source = string.Empty,
             Tokens = Array.Empty<MethodToken>(),
             Script = new byte[] { 0x01, 0x02, 0x03 }
         };
@@ -86,6 +87,7 @@ public void ParseTest()
             var file = new NefFile()
             {
                 Compiler = "".PadLeft(32, ' '),
+                Source = string.Empty,
                 Tokens = Array.Empty<MethodToken>(),
                 Script = new byte[] { 0x01, 0x02, 0x03 }
             };
@@ -105,6 +107,7 @@ public void LimitTest()
             var file = new NefFile()
             {
                 Compiler = "".PadLeft(byte.MaxValue, ' '),
+                Source = string.Empty,
                 Tokens = Array.Empty<MethodToken>(),
                 Script = new byte[1024 * 1024],
                 CheckSum = 0