Turn ByteQueue into MemoryStream wrapper, use MemoryStream for serialization of COutP...
[NovacoinLibrary.git] / Novacoin / CScript.cs
index 405a4b3..229b60b 100644 (file)
@@ -20,26 +20,10 @@ using System;
 using System.Linq;
 using System.Text;
 using System.Collections.Generic;
+using System.Diagnostics.Contracts;
 
 namespace Novacoin
 {
-    public class CScriptException : Exception
-    {
-        public CScriptException()
-        {
-        }
-
-        public CScriptException(string message)
-            : base(message)
-        {
-        }
-
-        public CScriptException(string message, Exception inner)
-            : base(message, inner)
-        {
-        }
-    }
-
     /// <summary>
     /// Representation of script code
     /// </summary>
@@ -59,7 +43,7 @@ namespace Novacoin
         /// Initializes new instance of CScript and fills it with supplied bytes
         /// </summary>
         /// <param name="bytes">Enumerator interface for byte sequence</param>
-        public CScript(IEnumerable<byte> bytes)
+        public CScript(byte[] bytes)
         {
             codeBytes = new List<byte>(bytes);
         }
@@ -68,9 +52,9 @@ namespace Novacoin
         /// Return a new instance of ByteQueue object for current code bytes
         /// </summary>
         /// <returns></returns>
-        public ByteQueue GetByteQUeue()
+        public ByteQueue GetByteQueue()
         {
-             return new ByteQueue(codeBytes);
+             return new ByteQueue(ref codeBytes);
         }
 
         /// <summary>
@@ -79,10 +63,7 @@ namespace Novacoin
         /// <param name="opcode"></param>
         public void AddInstruction(instruction opcode)
         {
-            if (opcode < instruction.OP_0 || opcode > instruction.OP_INVALIDOPCODE)
-            {
-                throw new CScriptException("CScript::AddInstruction() : invalid instruction");
-            }
+            Contract.Requires<ArgumentException>(opcode >= instruction.OP_0 && opcode <= instruction.OP_INVALIDOPCODE, "Invalid instruction.");
 
             codeBytes.Add((byte)opcode);
         }
@@ -96,7 +77,7 @@ namespace Novacoin
         public void AddHash(Hash160 hash)
         {
             codeBytes.Add((byte)hash.hashSize);
-            codeBytes.AddRange(hash.hashBytes);
+            codeBytes.AddRange((byte[])hash);
         }
 
         /// <summary>
@@ -108,7 +89,7 @@ namespace Novacoin
         public void AddHash(Hash256 hash)
         {
             codeBytes.Add((byte)hash.hashSize);
-            codeBytes.AddRange(hash.hashBytes);
+            codeBytes.AddRange((byte[])hash);
         }
 
         /// <summary>
@@ -132,18 +113,18 @@ namespace Novacoin
             }
             else if (nCount < 0xffff)
             {
-                // OP_PUSHDATA1 0x00 0x01 [0x5a]
+                // OP_PUSHDATA1 0x01 0x00 [0x5a]
                 codeBytes.Add((byte)instruction.OP_PUSHDATA2);
 
-                byte[] szBytes = Interop.BEBytes((ushort)nCount);
+                var szBytes = BitConverter.GetBytes((ushort)nCount);
                 codeBytes.AddRange(szBytes);
             }
             else if (nCount < 0xffffffff)
             {
-                // OP_PUSHDATA1 0x00 0x00 0x00 0x01 [0x5a]
+                // OP_PUSHDATA1 0x01 0x00 0x00 0x00 [0x5a]
                 codeBytes.Add((byte)instruction.OP_PUSHDATA4);
 
-                byte[] szBytes = Interop.BEBytes((uint)nCount);
+                var szBytes = BitConverter.GetBytes((uint)nCount);
                 codeBytes.AddRange(szBytes);
             }
 
@@ -152,39 +133,102 @@ namespace Novacoin
         }
 
         /// <summary>
-        /// Scan code bytes for pattern
+        /// Just insert data array without including any prefixes. Please make sure that you know what you're doing, 
+        ///    it is recommended to use AddInstruction, AddHash or PushData instead.
+        /// </summary>
+        /// <param name="dataBytes">Data bytes</param>
+        public void AddRawData(byte[] dataBytes)
+        {
+            // Add data bytes
+            codeBytes.AddRange(dataBytes);
+        }
+
+        /// <summary>
+        /// Scan pushed data bytes for pattern and, in case of exact match, remove it.
         /// </summary>
         /// <param name="pattern">Pattern sequence</param>
-        /// <returns>Matches enumerator</returns>
-        private IEnumerable<int> FindPattern(byte[] pattern)
+        /// <returns>Matches count</returns>
+        public int RemovePattern(byte[] pattern)
         {
-            for (int i = 0; i < codeBytes.Count; i++)
+            // There is no sense to continue if pattern is empty or longer than script itself
+            if (pattern.Length == 0 || pattern.Length > codeBytes.Count)
             {
-                if (codeBytes.Skip(i).Take(pattern.Length).SequenceEqual(pattern))
+                return 0;
+            }
+
+            var count = 0;
+            var bq1 = new ByteQueue(ref codeBytes);
+
+            byte[] pushData;
+            instruction opcode;
+
+            var newScript = new CScript();
+
+            while (ScriptCode.GetOp(ref bq1, out opcode, out pushData))
+            {
+                if (pushData.Length == 0)
+                {
+                    // No data, put instruction on its place
+                    newScript.AddInstruction(opcode);
+                }
+                else if (!pushData.SequenceEqual(pattern))
+                {
+                    // No match, create push operator
+                    newScript.PushData(pushData);
+                }
+                else
                 {
-                    yield return i;
+                    count++; // match
                 }
             }
+
+            if (count > 0)
+            {
+                // Replace current script if any matches were found
+                codeBytes = newScript.codeBytes;
+            }
+
+            return count;
         }
 
         /// <summary>
-        /// Scan code bytes for pattern and remove it
+        /// Scan script for specific instruction and remove it if there are some matches.
         /// </summary>
-        /// <param name="pattern">Pattern sequence</param>
-        /// <returns>Matches number</returns>
-        public int RemovePattern(byte[] pattern)
+        /// <param name="op">Instruction</param>
+        /// <returns>Matches count</returns>
+        public int RemoveInstruction(instruction op)
         {
-            var resultBytes = new List<byte>(codeBytes);
-            int count = 0;
-                        
-            foreach (int i in FindPattern(pattern))
+            byte[] pushData;
+            instruction opcode;
+
+            var count = 0;
+            var newScript = new CScript();
+            var bq1 = new ByteQueue(ref codeBytes);
+
+            while (ScriptCode.GetOp(ref bq1, out opcode, out pushData))
+            {
+                if (pushData.Length != 0 && op != opcode)
+                {
+                    // If instruction didn't match then push its data again
+                    newScript.PushData(pushData);
+                }
+                else if (Enum.IsDefined(typeof(instruction), op) && op != opcode)
+                {
+                    // Instruction didn't match
+                    newScript.AddInstruction(opcode);
+                }
+                else
+                {
+                    count++; // match
+                }
+            }
+
+            if (count > 0)
             {
-                resultBytes.RemoveRange(i - count * pattern.Length, pattern.Length);
-                count++;
+                // Replace current script if any matches were found
+                codeBytes = newScript.codeBytes;
             }
 
-            codeBytes = resultBytes;
-            
             return count;
         }
 
@@ -195,17 +239,17 @@ namespace Novacoin
         {
             get
             {
-                var wCodeBytes = new ByteQueue(codeBytes);
+                var wCodeBytes = new ByteQueue(ref codeBytes);
 
-                instruction opcode; // Current opcode
+                instruction opcode; // Current instruction
                 byte[] pushArgs; // OP_PUSHDATAn argument
 
-                // Scan opcodes sequence
+                // Scan instructions sequence
                 while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
                 {
                     if (opcode > instruction.OP_16)
                     {
-                        // We don't allow control opcodes here
+                        // We don't allow control instructions here
                         return false;
                     }
                 }
@@ -221,12 +265,12 @@ namespace Novacoin
         {
             get
             {
-                var wCodeBytes = new ByteQueue(codeBytes);
+                var wCodeBytes = new ByteQueue(ref codeBytes);
 
                 byte[] pushArgs; // OP_PUSHDATAn argument
-                instruction opcode; // Current opcode
+                instruction opcode; // Current instruction
 
-                // Scan opcodes sequence
+                // Scan instructions sequence
                 while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
                 {
                     var data = pushArgs;
@@ -308,17 +352,17 @@ namespace Novacoin
         /// </summary>
         /// <param name="fAccurate">Legacy mode flag</param>
         /// <returns>Amount of sigops</returns>
-        public int GetSigOpCount(bool fAccurate)
+        public uint GetSigOpCount(bool fAccurate)
         {
-            var wCodeBytes = new ByteQueue(codeBytes);
+            var wCodeBytes = new ByteQueue(ref codeBytes);
 
-            instruction opcode; // Current opcode
+            instruction opcode; // Current instruction
             byte[] pushArgs; // OP_PUSHDATAn argument
 
-            int nCount = 0;
+            uint nCount = 0;
             var lastOpcode = instruction.OP_INVALIDOPCODE;
 
-            // Scan opcodes sequence
+            // Scan instructions sequence
             while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
             {
                 if (opcode == instruction.OP_CHECKSIG || opcode == instruction.OP_CHECKSIGVERIFY)
@@ -329,7 +373,7 @@ namespace Novacoin
                 {
                     if (fAccurate && lastOpcode >= instruction.OP_1 && lastOpcode <= instruction.OP_16)
                     {
-                        nCount += ScriptCode.DecodeOP_N(lastOpcode);
+                        nCount += (uint)ScriptCode.DecodeOP_N(lastOpcode);
                     }
                     else
                     {
@@ -347,7 +391,7 @@ namespace Novacoin
         /// </summary>
         /// <param name="scriptSig">pay-to-script-hash scriptPubKey</param>
         /// <returns>SigOps count</returns>
-        public int GetSigOpCount(CScript scriptSig)
+        public uint GetSigOpCount(CScript scriptSig)
         {
             if (!IsPayToScriptHash)
             {
@@ -357,13 +401,20 @@ namespace Novacoin
             // This is a pay-to-script-hash scriptPubKey;
             // get the last item that the scriptSig
             // pushes onto the stack:
-            ByteQueue wScriptSig = scriptSig.GetByteQUeue();
+            ByteQueue wScriptSig = scriptSig.GetByteQueue();
+            int nScriptSigSize = scriptSig.Size;
+
+            instruction opcode; // Current instruction
+            byte[] pushArgs = new byte[0]; // OP_PUSHDATAn argument
 
-            instruction opcode; // Current opcode
-            byte[] pushArgs; // OP_PUSHDATAn argument
 
-            while (ScriptCode.GetOp(ref wScriptSig, out opcode, out pushArgs))
+            while (wScriptSig.Index < nScriptSigSize)
             {
+                if (!ScriptCode.GetOp(ref wScriptSig, out opcode, out pushArgs))
+                {
+                    return 0;
+                }
+
                 if (opcode > instruction.OP_16)
                 {
                     return 0;
@@ -384,7 +435,7 @@ namespace Novacoin
         public void SetDestination(CPubKey pubKey)
         {
             codeBytes.Clear();
-            PushData(pubKey.PublicBytes);
+            PushData(pubKey);
             AddInstruction(instruction.OP_CHECKSIG);
         }
 
@@ -434,7 +485,7 @@ namespace Novacoin
 
             foreach (var key in keys)
             {
-                PushData(key.PublicBytes);
+                PushData(key);
             }
 
             AddInstruction(ScriptCode.EncodeOP_N(keys.Length));
@@ -444,9 +495,17 @@ namespace Novacoin
         /// <summary>
         /// Access to script code.
         /// </summary>
-        public byte[] Bytes
+        public static implicit operator byte[] (CScript script)
+        {
+            return script.codeBytes.ToArray();
+        }
+
+        /// <summary>
+        /// Script size
+        /// </summary>
+        public int Size
         {
-            get { return codeBytes.ToArray(); }
+            get { return codeBytes.Count; }
         }
 
         public CScriptID ScriptID
@@ -461,9 +520,9 @@ namespace Novacoin
                public override string ToString()
                {
                        var sb = new StringBuilder();
-            var wCodeBytes = new ByteQueue(codeBytes);
+            var wCodeBytes = new ByteQueue(ref codeBytes);
 
-            instruction opcode; // Current opcode
+            instruction opcode; // Current instruction
             byte[] pushArgs; // OP_PUSHDATAn argument
             while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
             {