X-Git-Url: https://git.novaco.in/?a=blobdiff_plain;f=Novacoin%2FCScript.cs;h=abdad9c238b64cfd219295ebe5e86e01e3f9ea15;hb=6dfa6de57c6493b76856acc9ab510ac31962c327;hp=565b6a21fe5e7e780a21c96ba500db3ba2668e77;hpb=be834adfb84c418d7915a186ee13651312eab1d1;p=NovacoinLibrary.git
diff --git a/Novacoin/CScript.cs b/Novacoin/CScript.cs
index 565b6a2..abdad9c 100644
--- a/Novacoin/CScript.cs
+++ b/Novacoin/CScript.cs
@@ -1,27 +1,30 @@
-using System;
+/**
+ * Novacoin classes library
+ * Copyright (C) 2015 Alex D. (balthazar.ad@gmail.com)
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see .
+ */
+
+using System;
using System.Linq;
using System.Text;
using System.Collections.Generic;
+using System.Diagnostics.Contracts;
+using System.Numerics;
namespace Novacoin
{
- public class CScriptException : Exception
- {
- public CScriptException()
- {
- }
-
- public CScriptException(string message)
- : base(message)
- {
- }
-
- public CScriptException(string message, Exception inner)
- : base(message, inner)
- {
- }
- }
-
///
/// Representation of script code
///
@@ -41,67 +44,81 @@ namespace Novacoin
/// Initializes new instance of CScript and fills it with supplied bytes
///
/// Enumerator interface for byte sequence
- public CScript(IEnumerable bytes)
+ public CScript(byte[] bytes)
{
codeBytes = new List(bytes);
}
///
- /// Return a new instance of WrappedList object for current code bytes
+ /// Return a new instance of ByteQueue object for current code bytes
///
///
- public WrappedList GetWrappedList()
+ public InstructionQueue GetInstructionQueue()
{
- return new WrappedList(codeBytes);
+ return new InstructionQueue(ref codeBytes);
}
///
- /// Adds specified operation to opcode bytes list
+ /// Add serialized number to instructions list.
///
- ///
- public void AddOp(opcodetype opcode)
+ /// Number to add.
+ public void AddNumber(int n)
{
- if (opcode < opcodetype.OP_0 || opcode > opcodetype.OP_INVALIDOPCODE)
+ if (n == -1 || (n >= 1 && n <= 16))
{
- throw new CScriptException("CScript::AddOp() : invalid opcode");
+ codeBytes.Add((byte)ScriptCode.EncodeOP_N(n, true));
}
+ else
+ {
+ BigInteger bn = n;
+ PushData(bn.ToByteArray());
+ }
+ }
+
+ ///
+ /// Adds specified operation to instruction list
+ ///
+ /// Instruction to add.
+ public void AddInstruction(instruction opcode)
+ {
+ Contract.Requires(opcode >= instruction.OP_0 && opcode <= instruction.OP_INVALIDOPCODE, "Invalid instruction.");
codeBytes.Add((byte)opcode);
}
///
- /// Adds hash to opcode bytes list.
+ /// Adds hash to instruction list.
/// New items are added in this format:
/// hash_length_byte hash_bytes
///
- /// Hash160 instance
- public void AddHash(Hash160 hash)
+ /// uint160 instance
+ public void AddHash(uint160 hash)
{
- codeBytes.Add((byte)hash.hashSize);
- codeBytes.AddRange(hash.hashBytes);
+ codeBytes.Add((byte)hash.Size);
+ codeBytes.AddRange((byte[])hash);
}
///
- /// Adds hash to opcode bytes list.
+ /// Adds hash to instruction list.
/// New items are added in this format:
/// hash_length_byte hash_bytes
///
- /// Hash256 instance
- public void AddHash(Hash256 hash)
+ /// uint256 instance
+ public void AddHash(uint256 hash)
{
- codeBytes.Add((byte)hash.hashSize);
- codeBytes.AddRange(hash.hashBytes);
+ codeBytes.Add((byte)hash.Size);
+ codeBytes.AddRange((byte[])hash);
}
///
- /// Create new OP_PUSHDATAn operator and add it to opcode bytes list
+ /// Create new OP_PUSHDATAn operator and add it to instruction list
///
- /// List of data bytes
- public void PushData(IList dataBytes)
+ /// Set of data bytes
+ public void PushData(byte[] dataBytes)
{
- long nCount = dataBytes.LongCount();
+ var nCount = dataBytes.LongLength;
- if (nCount < (int)opcodetype.OP_PUSHDATA1)
+ if (nCount < (int)instruction.OP_PUSHDATA1)
{
// OP_0 and OP_FALSE
codeBytes.Add((byte)nCount);
@@ -109,23 +126,23 @@ namespace Novacoin
else if (nCount < 0xff)
{
// OP_PUSHDATA1 0x01 [0x5a]
- codeBytes.Add((byte)opcodetype.OP_PUSHDATA1);
+ codeBytes.Add((byte)instruction.OP_PUSHDATA1);
codeBytes.Add((byte)nCount);
}
else if (nCount < 0xffff)
{
- // OP_PUSHDATA1 0x00 0x01 [0x5a]
- codeBytes.Add((byte)opcodetype.OP_PUSHDATA2);
+ // 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]
- codeBytes.Add((byte)opcodetype.OP_PUSHDATA4);
+ // 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);
}
@@ -134,112 +151,177 @@ namespace Novacoin
}
///
- /// 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.
+ ///
+ /// Data bytes
+ public void AddRawData(byte[] dataBytes)
+ {
+ // Add data bytes
+ codeBytes.AddRange(dataBytes);
+ }
+
+ ///
+ /// Scan pushed data bytes for pattern and, in case of exact match, remove it.
///
/// Pattern sequence
- /// Matches enumerator
- private IEnumerable FindPattern(IList pattern)
+ /// Matches count
+ 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)
+ {
+ return 0;
+ }
+
+ var count = 0;
+ var bq1 = new InstructionQueue(ref codeBytes);
+
+ byte[] pushData;
+ instruction opcode;
+
+ var newScript = new CScript();
+
+ while (ScriptCode.GetOp(ref bq1, out opcode, out pushData))
{
- if (codeBytes.Skip(i).Take(pattern.Count).SequenceEqual(pattern))
+ if (pushData.Length == 0)
{
- yield return i;
+ // No data, put instruction on its place
+ newScript.AddInstruction(opcode);
+ }
+ else if (!pushData.SequenceEqual(pattern))
+ {
+ // No match, create push operator
+ newScript.PushData(pushData);
+ }
+ else
+ {
+ count++; // match
}
}
+
+ if (count > 0)
+ {
+ // Replace current script if any matches were found
+ codeBytes = newScript.codeBytes;
+ }
+
+ return count;
}
///
- /// Scan code bytes for pattern and remove it
+ /// Scan script for specific instruction and remove it if there are some matches.
///
- /// Pattern sequence
- /// Matches number
- public int RemovePattern(IList pattern)
+ /// Instruction
+ /// Matches count
+ public int RemoveInstruction(instruction op)
{
- List resultBytes = new List(codeBytes);
- int count = 0;
- int patternLen = pattern.Count;
-
- foreach (int i in FindPattern(pattern))
+ byte[] pushData;
+ instruction opcode;
+
+ var count = 0;
+ var newScript = new CScript();
+ var bq1 = new InstructionQueue(ref codeBytes);
+
+ while (ScriptCode.GetOp(ref bq1, out opcode, out pushData))
{
- resultBytes.RemoveRange(i - count * patternLen, patternLen);
- count++;
+ 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)
+ {
+ // Replace current script if any matches were found
+ codeBytes = newScript.codeBytes;
}
- codeBytes = resultBytes;
-
return count;
}
///
/// Is it true that script doesn't contain anything except push value operations?
///
- /// Checking result
- public bool IsPushonly()
+ public bool IsPushOnly
{
- WrappedList wCodeBytes = new WrappedList(codeBytes);
-
- opcodetype opcode; // Current opcode
- IEnumerable pushArgs; // OP_PUSHDATAn argument
-
- // Scan opcodes sequence
- while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
+ get
{
- if (opcode > opcodetype.OP_16)
+ var wCodeBytes = new InstructionQueue(ref codeBytes);
+
+ instruction opcode; // Current instruction
+ byte[] pushArgs; // OP_PUSHDATAn argument
+
+ // Scan instructions sequence
+ while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
{
- // We don't allow control opcodes here
- return false;
+ if (opcode > instruction.OP_16)
+ {
+ // We don't allow control instructions here
+ return false;
+ }
}
- }
- return true;
+ return true;
+ }
}
///
/// Is it true that script doesn't contain non-canonical push operations?
///
- /// Checking result
- public bool HashOnlyCanonicalPushes()
+ public bool HasOnlyCanonicalPushes
{
- WrappedList wCodeBytes = new WrappedList(codeBytes);
-
- opcodetype opcode; // Current opcode
- IEnumerable pushArgs; // OP_PUSHDATAn argument
-
- // Scan opcodes sequence
- while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
+ get
{
- byte[] data = pushArgs.ToArray();
+ var wCodeBytes = new InstructionQueue(ref codeBytes);
- if (opcode < opcodetype.OP_PUSHDATA1 && opcode > opcodetype.OP_0 && (data.Length == 1 && data[0] <= 16))
- {
- // Could have used an OP_n code, rather than a 1-byte push.
- return false;
- }
- if (opcode == opcodetype.OP_PUSHDATA1 && data.Length < (int)opcodetype.OP_PUSHDATA1)
- {
- // Could have used a normal n-byte push, rather than OP_PUSHDATA1.
- return false;
- }
- if (opcode == opcodetype.OP_PUSHDATA2 && data.Length <= 0xFF)
- {
- // Could have used an OP_PUSHDATA1.
- return false;
- }
- if (opcode == opcodetype.OP_PUSHDATA4 && data.LongLength <= 0xFFFF)
+ byte[] pushArgs; // OP_PUSHDATAn argument
+ instruction opcode; // Current instruction
+
+ // Scan instructions sequence
+ while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
{
- // Could have used an OP_PUSHDATA2.
- return false;
+ var data = pushArgs;
+
+ if (opcode < instruction.OP_PUSHDATA1 && opcode > instruction.OP_0 && (data.Length == 1 && data[0] <= 16))
+ {
+ // Could have used an OP_n code, rather than a 1-byte push.
+ return false;
+ }
+ if (opcode == instruction.OP_PUSHDATA1 && data.Length < (int)instruction.OP_PUSHDATA1)
+ {
+ // Could have used a normal n-byte push, rather than OP_PUSHDATA1.
+ return false;
+ }
+ if (opcode == instruction.OP_PUSHDATA2 && data.Length <= 0xFF)
+ {
+ // Could have used an OP_PUSHDATA1.
+ return false;
+ }
+ if (opcode == instruction.OP_PUSHDATA4 && data.LongLength <= 0xFFFF)
+ {
+ // Could have used an OP_PUSHDATA2.
+ return false;
+ }
}
- }
- return true;
+ return true;
+ }
}
///
/// Quick test for pay-to-script-hash CScripts
///
- /// Checking result
public bool IsPayToScriptHash
{
get
@@ -247,33 +329,39 @@ namespace Novacoin
// Sender provides redeem script hash, receiver provides signature list and redeem script
// OP_HASH160 20 [20 byte hash] OP_EQUAL
return (codeBytes.Count() == 23 &&
- codeBytes[0] == (byte)opcodetype.OP_HASH160 &&
+ codeBytes[0] == (byte)instruction.OP_HASH160 &&
codeBytes[1] == 0x14 && // 20 bytes hash length prefix
- codeBytes[22] == (byte)opcodetype.OP_EQUAL);
+ codeBytes[22] == (byte)instruction.OP_EQUAL);
}
}
///
/// Quick test for pay-to-pubkeyhash CScripts
///
- /// Checking result
public bool IsPayToPubKeyHash
{
get
{
// Sender provides hash of pubkey, receiver provides signature and pubkey
// OP_DUP OP_HASH160 20 [20 byte hash] OP_EQUALVERIFY OP_CHECKSIG
-
return (codeBytes.Count == 25 &&
- codeBytes[0] == (byte)opcodetype.OP_DUP &&
- codeBytes[1] == (byte)opcodetype.OP_HASH160 &&
+ codeBytes[0] == (byte)instruction.OP_DUP &&
+ codeBytes[1] == (byte)instruction.OP_HASH160 &&
codeBytes[2] == 0x14 && // 20 bytes hash length prefix
- codeBytes[23] == (byte)opcodetype.OP_EQUALVERIFY &&
- codeBytes[24] == (byte)opcodetype.OP_CHECKSIG);
+ codeBytes[23] == (byte)instruction.OP_EQUALVERIFY &&
+ codeBytes[24] == (byte)instruction.OP_CHECKSIG);
}
}
///
+ /// Quick test for Null destination
+ ///
+ public bool IsNull
+ {
+ get { return codeBytes.Count == 0; }
+ }
+
+ ///
/// Pre-version-0.6, Bitcoin always counted CHECKMULTISIGs
/// as 20 sigops. With pay-to-script-hash, that changed:
/// CHECKMULTISIGs serialized in scriptSigs are
@@ -282,28 +370,28 @@ namespace Novacoin
///
/// Legacy mode flag
/// Amount of sigops
- public int GetSigOpCount(bool fAccurate)
+ public uint GetSigOpCount(bool fAccurate)
{
- WrappedList wCodeBytes = new WrappedList(codeBytes);
+ var wCodeBytes = new InstructionQueue(ref codeBytes);
- opcodetype opcode; // Current opcode
- IEnumerable pushArgs; // OP_PUSHDATAn argument
+ instruction opcode; // Current instruction
+ byte[] pushArgs; // OP_PUSHDATAn argument
- int nCount = 0;
- opcodetype lastOpcode = opcodetype.OP_INVALIDOPCODE;
+ 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 == opcodetype.OP_CHECKSIG || opcode == opcodetype.OP_CHECKSIGVERIFY)
+ if (opcode == instruction.OP_CHECKSIG || opcode == instruction.OP_CHECKSIGVERIFY)
{
nCount++;
}
- else if (opcode == opcodetype.OP_CHECKMULTISIG || opcode == opcodetype.OP_CHECKMULTISIGVERIFY)
+ else if (opcode == instruction.OP_CHECKMULTISIG || opcode == instruction.OP_CHECKMULTISIGVERIFY)
{
- if (fAccurate && lastOpcode >= opcodetype.OP_1 && lastOpcode <= opcodetype.OP_16)
+ if (fAccurate && lastOpcode >= instruction.OP_1 && lastOpcode <= instruction.OP_16)
{
- nCount += ScriptCode.DecodeOP_N(lastOpcode);
+ nCount += (uint)ScriptCode.DecodeOP_N(lastOpcode);
}
else
{
@@ -321,7 +409,7 @@ namespace Novacoin
///
/// pay-to-script-hash scriptPubKey
/// SigOps count
- public int GetSigOpCount(CScript scriptSig)
+ public uint GetSigOpCount(CScript scriptSig)
{
if (!IsPayToScriptHash)
{
@@ -331,62 +419,125 @@ namespace Novacoin
// This is a pay-to-script-hash scriptPubKey;
// get the last item that the scriptSig
// pushes onto the stack:
- WrappedList wScriptSig = scriptSig.GetWrappedList();
+ InstructionQueue wScriptSig = scriptSig.GetInstructionQueue();
+ uint nScriptSigSize = scriptSig.Size;
- opcodetype opcode; // Current opcode
- IEnumerable pushArgs; // OP_PUSHDATAn argument
+ instruction opcode; // Current instruction
+ byte[] pushArgs = new byte[0]; // OP_PUSHDATAn argument
- while (ScriptCode.GetOp(ref wScriptSig, out opcode, out pushArgs))
+
+ while (wScriptSig.Index < nScriptSigSize)
{
- if (opcode > opcodetype.OP_16)
+ if (!ScriptCode.GetOp(ref wScriptSig, out opcode, out pushArgs))
+ {
+ return 0;
+ }
+
+ if (opcode > instruction.OP_16)
{
return 0;
}
}
/// ... and return its opcount:
- CScript subScript = new CScript(pushArgs);
+ var subScript = new CScript(pushArgs);
return subScript.GetSigOpCount(true);
}
+ ///
+ /// Set pay-to-pubkey destination.
+ ///
+ /// Instance of CPubKey.
+ public void SetDestination(CPubKey pubKey)
+ {
+ codeBytes.Clear();
+ PushData(pubKey);
+ AddInstruction(instruction.OP_CHECKSIG);
+ }
+
+ ///
+ /// Set pay-to-pubkeyhash destination
+ ///
+ /// Public key hash
public void SetDestination(CKeyID ID)
{
codeBytes.Clear();
- AddOp(opcodetype.OP_DUP);
- AddOp(opcodetype.OP_HASH160);
+ AddInstruction(instruction.OP_DUP);
+ AddInstruction(instruction.OP_HASH160);
AddHash(ID);
- AddOp(opcodetype.OP_EQUAL);
+ AddInstruction(instruction.OP_EQUALVERIFY);
+ AddInstruction(instruction.OP_CHECKSIG);
}
+ ///
+ /// Set pay-to-scripthash destination
+ ///
+ /// Script hash
public void SetDestination(CScriptID ID)
{
codeBytes.Clear();
- AddOp(opcodetype.OP_HASH160);
+ AddInstruction(instruction.OP_HASH160);
AddHash(ID);
- AddOp(opcodetype.OP_EQUAL);
+ AddInstruction(instruction.OP_EQUAL);
+ }
+
+ ///
+ /// Reset script code buffer.
+ ///
+ public void SetNullDestination()
+ {
+ codeBytes.Clear();
}
- public void SetMultiSig(int nRequired, IEnumerable keys)
+ ///
+ /// Set multisig destination.
+ ///
+ /// Amount of required signatures.
+ /// Set of public keys.
+ public void SetMultiSig(int nRequired, CPubKey[] keys)
{
codeBytes.Clear();
- AddOp(ScriptCode.EncodeOP_N(nRequired));
+ AddInstruction(ScriptCode.EncodeOP_N(nRequired));
- foreach (CPubKey key in keys)
+ foreach (var key in keys)
{
- PushData(key.PublicBytes.ToList());
+ PushData(key);
}
- AddOp(ScriptCode.EncodeOP_N(keys.Count()));
- AddOp(opcodetype.OP_CHECKMULTISIG);
+
+ AddInstruction(ScriptCode.EncodeOP_N(keys.Length));
+ AddInstruction(instruction.OP_CHECKMULTISIG);
}
///
/// Access to script code.
///
- public IEnumerable Enumerable
+ public static implicit operator byte[] (CScript script)
+ {
+ return script.codeBytes.ToArray();
+ }
+
+ ///
+ /// Implicit cast of byte array to CScript.
+ ///
+ ///
+ public static implicit operator CScript(byte[] scriptBytes)
+ {
+ return new CScript(scriptBytes);
+ }
+
+ ///
+ /// Script size
+ ///
+ public uint Size
{
- get { return codeBytes; }
+ get { return (uint) codeBytes.Count; }
+ }
+
+ public CScriptID ScriptID
+ {
+ get { return new CScriptID(CryptoUtils.ComputeHash160(codeBytes.ToArray())); }
}
///
@@ -395,11 +546,11 @@ namespace Novacoin
/// Code listing
public override string ToString()
{
- StringBuilder sb = new StringBuilder();
- WrappedList wCodeBytes = new WrappedList(codeBytes);
+ var sb = new StringBuilder();
+ var wCodeBytes = new InstructionQueue(ref codeBytes);
- opcodetype opcode; // Current opcode
- IEnumerable pushArgs; // OP_PUSHDATAn argument
+ instruction opcode; // Current instruction
+ byte[] pushArgs; // OP_PUSHDATAn argument
while (ScriptCode.GetOp(ref wCodeBytes, out opcode, out pushArgs))
{
if (sb.Length != 0)
@@ -407,7 +558,7 @@ namespace Novacoin
sb.Append(" ");
}
- if (0 <= opcode && opcode <= opcodetype.OP_PUSHDATA4)
+ if (0 <= opcode && opcode <= instruction.OP_PUSHDATA4)
{
sb.Append(ScriptCode.ValueString(pushArgs));
}
@@ -421,4 +572,3 @@ namespace Novacoin
}
}
}
-