2014-07-18 13:56:17 +00:00
|
|
|
// Rust Bitcoin Library
|
|
|
|
// Written in 2014 by
|
2015-04-07 01:51:11 +00:00
|
|
|
// Andrew Poelstra <apoelstra@wpsoftware.net>
|
2014-07-18 13:56:17 +00:00
|
|
|
//
|
|
|
|
// To the extent possible under law, the author(s) have dedicated all
|
|
|
|
// copyright and related and neighboring rights to this software to
|
|
|
|
// the public domain worldwide. This software is distributed without
|
|
|
|
// any warranty.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the CC0 Public Domain Dedication
|
|
|
|
// along with this software.
|
|
|
|
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
|
|
|
|
//
|
|
|
|
|
|
|
|
//! # Script
|
|
|
|
//!
|
|
|
|
//! Scripts define Bitcoin's digital signature scheme: a signature is formed
|
|
|
|
//! from a script (the second half of which is defined by a coin to be spent,
|
|
|
|
//! and the first half provided by the spending transaction), and is valid
|
|
|
|
//! iff the script leaves `TRUE` on the stack after being evaluated.
|
|
|
|
//! Bitcoin's script is a stack-based assembly language similar in spirit to
|
|
|
|
//! Forth.
|
|
|
|
//!
|
|
|
|
//! This module provides the structures and functions needed to support scripts.
|
|
|
|
//!
|
|
|
|
|
2014-08-11 02:35:58 +00:00
|
|
|
use std::default::Default;
|
2016-06-12 00:03:10 +00:00
|
|
|
use std::{error, fmt};
|
|
|
|
|
2015-04-06 00:10:37 +00:00
|
|
|
use serde;
|
2014-08-10 19:58:15 +00:00
|
|
|
|
2014-07-18 13:56:17 +00:00
|
|
|
use blockdata::opcodes;
|
2014-08-01 16:01:39 +00:00
|
|
|
use network::encodable::{ConsensusDecodable, ConsensusEncodable};
|
2016-06-12 00:03:10 +00:00
|
|
|
use network::serialize::{SimpleDecoder, SimpleEncoder};
|
2014-07-18 13:56:17 +00:00
|
|
|
|
2016-02-18 19:25:40 +00:00
|
|
|
#[derive(Clone, PartialEq, Eq, Hash)]
|
2014-07-18 13:56:17 +00:00
|
|
|
/// A Bitcoin script
|
2015-04-05 03:13:19 +00:00
|
|
|
pub struct Script(Box<[u8]>);
|
2014-07-18 13:56:17 +00:00
|
|
|
|
2015-12-04 16:59:43 +00:00
|
|
|
impl fmt::Debug for Script {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
let mut index = 0;
|
|
|
|
|
|
|
|
try!(f.write_str("Script("));
|
|
|
|
while index < self.0.len() {
|
|
|
|
let opcode = opcodes::All::from(self.0[index]);
|
|
|
|
|
|
|
|
let data_len = if let opcodes::Class::PushBytes(n) = opcode.classify() {
|
|
|
|
n as usize
|
|
|
|
} else {
|
|
|
|
match opcode {
|
|
|
|
opcodes::All::OP_PUSHDATA1 => {
|
|
|
|
if self.0.len() < index + 1 {
|
|
|
|
try!(f.write_str("<unexpected end>"));
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
match read_uint(&self.0[index..], 1) {
|
|
|
|
Ok(n) => { index += 1; n as usize }
|
|
|
|
Err(_) => { try!(f.write_str("<bad length>")); break; }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
opcodes::All::OP_PUSHDATA2 => {
|
|
|
|
if self.0.len() < index + 2 {
|
|
|
|
try!(f.write_str("<unexpected end>"));
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
match read_uint(&self.0[index..], 2) {
|
|
|
|
Ok(n) => { index += 2; n as usize }
|
|
|
|
Err(_) => { try!(f.write_str("<bad length>")); break; }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
opcodes::All::OP_PUSHDATA4 => {
|
|
|
|
if self.0.len() < index + 4 {
|
|
|
|
try!(f.write_str("<unexpected end>"));
|
2016-06-12 00:03:10 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
match read_uint(&self.0[index..], 4) {
|
|
|
|
Ok(n) => { index += 4; n as usize }
|
|
|
|
Err(_) => { try!(f.write_str("<bad length>")); break; }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => 0
|
|
|
|
}
|
|
|
|
};
|
2015-04-07 01:51:11 +00:00
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
if index > 0 { try!(f.write_str(" ")); }
|
|
|
|
// Write the opcode
|
|
|
|
if opcode == opcodes::All::OP_PUSHBYTES_0 {
|
|
|
|
try!(f.write_str("OP_0"));
|
|
|
|
} else {
|
|
|
|
try!(write!(f, "{:?}", opcode));
|
|
|
|
}
|
|
|
|
index += 1;
|
|
|
|
// Write any pushdata
|
|
|
|
if data_len > 0 {
|
|
|
|
try!(f.write_str(" "));
|
|
|
|
if index + data_len < self.0.len() {
|
|
|
|
for ch in &self.0[index..index + data_len] {
|
|
|
|
try!(write!(f, "{:02x}", ch));
|
|
|
|
}
|
|
|
|
index += data_len;
|
|
|
|
} else {
|
|
|
|
try!(f.write_str("<push past end>"));
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
f.write_str(")")
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-31 16:50:46 +00:00
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
impl fmt::Display for Script {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
fmt::Debug::fmt(self, f)
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-17 02:04:57 +00:00
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
impl fmt::LowerHex for Script {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
for &ch in self.0.iter() {
|
|
|
|
try!(write!(f, "{:02x}", ch));
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2016-06-12 00:03:10 +00:00
|
|
|
Ok(())
|
2015-04-05 17:58:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
impl fmt::UpperHex for Script {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
for &ch in self.0.iter() {
|
|
|
|
try!(write!(f, "{:02X}", ch));
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2016-06-12 00:03:10 +00:00
|
|
|
Ok(())
|
2015-04-05 17:58:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
#[derive(PartialEq, Eq, Debug, Clone)]
|
|
|
|
/// An object which can be used to construct a script piece by piece
|
|
|
|
pub struct Builder(Vec<u8>);
|
|
|
|
display_from_debug!(Builder);
|
2015-04-05 17:58:49 +00:00
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
/// Ways that a script might fail. Not everything is split up as
|
|
|
|
/// much as it could be; patches welcome if more detailed errors
|
|
|
|
/// would help you.
|
|
|
|
#[derive(PartialEq, Eq, Debug, Clone)]
|
|
|
|
pub enum Error {
|
|
|
|
/// Some opcode expected a parameter, but it was missing or truncated
|
|
|
|
EarlyEndOfScript,
|
|
|
|
/// Tried to read an array off the stack as a number when it was more than 4 bytes
|
|
|
|
NumericOverflow,
|
2015-04-05 17:58:49 +00:00
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
impl fmt::Display for Error {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
f.write_str(error::Error::description(self))
|
2015-04-05 17:58:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
impl error::Error for Error {
|
|
|
|
fn cause(&self) -> Option<&error::Error> { None }
|
2014-08-14 03:25:28 +00:00
|
|
|
|
2016-06-12 00:03:10 +00:00
|
|
|
fn description(&self) -> &'static str {
|
2015-04-07 01:51:11 +00:00
|
|
|
match *self {
|
2016-06-12 00:03:10 +00:00
|
|
|
Error::EarlyEndOfScript => "unexpected end of script",
|
|
|
|
Error::NumericOverflow => "numeric overflow (number on stack larger than 4 bytes)",
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-14 03:25:28 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-06 02:08:06 +00:00
|
|
|
/// Helper to encode an integer in script format
|
|
|
|
fn build_scriptint(n: i64) -> Vec<u8> {
|
2015-04-07 01:51:11 +00:00
|
|
|
if n == 0 { return vec![] }
|
|
|
|
|
|
|
|
let neg = n < 0;
|
|
|
|
|
|
|
|
let mut abs = if neg { -n } else { n } as usize;
|
|
|
|
let mut v = vec![];
|
|
|
|
while abs > 0xFF {
|
|
|
|
v.push((abs & 0xFF) as u8);
|
|
|
|
abs >>= 8;
|
|
|
|
}
|
|
|
|
// If the number's value causes the sign bit to be set, we need an extra
|
|
|
|
// byte to get the correct value and correct sign bit
|
|
|
|
if abs & 0x80 != 0 {
|
|
|
|
v.push(abs as u8);
|
|
|
|
v.push(if neg { 0x80u8 } else { 0u8 });
|
|
|
|
}
|
|
|
|
// Otherwise we just set the sign bit ourselves
|
|
|
|
else {
|
|
|
|
abs |= if neg { 0x80 } else { 0 };
|
|
|
|
v.push(abs as u8);
|
|
|
|
}
|
|
|
|
v
|
2014-08-06 02:08:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Helper to decode an integer in script format
|
|
|
|
/// Notice that this fails on overflow: the result is the same as in
|
|
|
|
/// bitcoind, that only 4-byte signed-magnitude values may be read as
|
|
|
|
/// numbers. They can be added or subtracted (and a long time ago,
|
|
|
|
/// multiplied and divided), and this may result in numbers which
|
|
|
|
/// can't be written out in 4 bytes or less. This is ok! The number
|
|
|
|
/// just can't be read as a number again.
|
|
|
|
/// This is a bit crazy and subtle, but it makes sense: you can load
|
|
|
|
/// 32-bit numbers and do anything with them, which back when mult/div
|
|
|
|
/// was allowed, could result in up to a 64-bit number. We don't want
|
|
|
|
/// overflow since that's suprising --- and we don't want numbers that
|
|
|
|
/// don't fit in 64 bits (for efficiency on modern processors) so we
|
|
|
|
/// simply say, anything in excess of 32 bits is no longer a number.
|
|
|
|
/// This is basically a ranged type implementation.
|
2015-04-05 17:58:49 +00:00
|
|
|
pub fn read_scriptint(v: &[u8]) -> Result<i64, Error> {
|
2015-04-07 01:51:11 +00:00
|
|
|
let len = v.len();
|
|
|
|
if len == 0 { return Ok(0); }
|
|
|
|
if len > 4 { return Err(Error::NumericOverflow); }
|
2014-08-06 02:08:06 +00:00
|
|
|
|
2015-04-07 01:51:11 +00:00
|
|
|
let (mut ret, sh) = v.iter()
|
|
|
|
.fold((0, 0), |(acc, sh), n| (acc + ((*n as i64) << sh), sh + 8));
|
|
|
|
if v[len - 1] & 0x80 != 0 {
|
2015-10-28 16:27:23 +00:00
|
|
|
ret &= (1 << (sh - 1)) - 1;
|
2015-04-07 01:51:11 +00:00
|
|
|
ret = -ret;
|
|
|
|
}
|
|
|
|
Ok(ret)
|
2014-08-06 02:08:06 +00:00
|
|
|
}
|
|
|
|
|
2016-06-21 14:35:27 +00:00
|
|
|
/// This is like "`read_scriptint` then map 0 to false and everything
|
2014-08-06 02:08:06 +00:00
|
|
|
/// else as true", except that the overflow rules don't apply.
|
|
|
|
#[inline]
|
2014-08-11 02:35:58 +00:00
|
|
|
pub fn read_scriptbool(v: &[u8]) -> bool {
|
2015-10-28 16:27:23 +00:00
|
|
|
!(v.is_empty() ||
|
2015-04-07 01:51:11 +00:00
|
|
|
((v[v.len() - 1] == 0 || v[v.len() - 1] == 0x80) &&
|
|
|
|
v.iter().rev().skip(1).all(|&w| w == 0)))
|
2014-08-06 02:08:06 +00:00
|
|
|
}
|
|
|
|
|
2014-08-11 02:35:58 +00:00
|
|
|
/// Read a script-encoded unsigned integer
|
2015-04-06 00:10:37 +00:00
|
|
|
pub fn read_uint(data: &[u8], size: usize) -> Result<usize, Error> {
|
2015-04-07 01:51:11 +00:00
|
|
|
if data.len() < size {
|
|
|
|
Err(Error::EarlyEndOfScript)
|
|
|
|
} else {
|
|
|
|
let mut ret = 0;
|
2016-02-18 19:25:40 +00:00
|
|
|
for (i, item) in data.iter().take(size).enumerate() {
|
|
|
|
ret += (*item as usize) << (i * 8);
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
Ok(ret)
|
2014-08-06 02:08:06 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-07-18 13:56:17 +00:00
|
|
|
impl Script {
|
2015-04-07 01:51:11 +00:00
|
|
|
/// Creates a new empty script
|
|
|
|
pub fn new() -> Script { Script(vec![].into_boxed_slice()) }
|
|
|
|
|
|
|
|
/// The length in bytes of the script
|
2015-04-07 22:51:57 +00:00
|
|
|
pub fn len(&self) -> usize { self.0.len() }
|
2015-04-07 01:51:11 +00:00
|
|
|
|
2015-10-28 16:27:23 +00:00
|
|
|
/// Whether the script is the empty script
|
|
|
|
pub fn is_empty(&self) -> bool { self.0.is_empty() }
|
|
|
|
|
2016-06-02 23:47:29 +00:00
|
|
|
/// Convert the script into a byte vector
|
|
|
|
pub fn into_vec(self) -> Vec<u8> { self.0.into_vec() }
|
|
|
|
|
2015-04-07 01:51:11 +00:00
|
|
|
/// Checks whether a script pubkey is a p2sh output
|
|
|
|
#[inline]
|
|
|
|
pub fn is_p2sh(&self) -> bool {
|
2015-04-11 01:55:59 +00:00
|
|
|
self.0.len() == 23 &&
|
|
|
|
self.0[0] == opcodes::All::OP_HASH160 as u8 &&
|
|
|
|
self.0[1] == opcodes::All::OP_PUSHBYTES_20 as u8 &&
|
|
|
|
self.0[22] == opcodes::All::OP_EQUAL as u8
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-15 00:05:07 +00:00
|
|
|
|
2015-04-07 01:51:11 +00:00
|
|
|
/// Whether a script can be proven to have no satisfying input
|
|
|
|
pub fn is_provably_unspendable(&self) -> bool {
|
2016-06-12 00:03:10 +00:00
|
|
|
!self.0.is_empty() && (opcodes::All::from(self.0[0]).classify() == opcodes::Class::ReturnOp ||
|
|
|
|
opcodes::All::from(self.0[0]).classify() == opcodes::Class::IllegalOp)
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-07-18 13:56:17 +00:00
|
|
|
}
|
|
|
|
|
2014-08-23 23:20:46 +00:00
|
|
|
impl Default for Script {
|
2015-04-07 01:51:11 +00:00
|
|
|
fn default() -> Script { Script(vec![].into_boxed_slice()) }
|
|
|
|
}
|
|
|
|
|
2015-10-14 13:56:48 +00:00
|
|
|
/// Creates a new script from an existing vector
|
|
|
|
impl From<Vec<u8>> for Script {
|
|
|
|
fn from(v: Vec<u8>) -> Script { Script(v.into_boxed_slice()) }
|
|
|
|
}
|
|
|
|
|
2015-04-07 22:51:57 +00:00
|
|
|
impl_index_newtype!(Script, u8);
|
2015-04-07 01:51:11 +00:00
|
|
|
|
2015-10-15 03:00:47 +00:00
|
|
|
/// A "parsed opcode" which allows iterating over a Script in a more sensible way
|
2016-05-04 14:03:58 +00:00
|
|
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
2015-10-15 03:00:47 +00:00
|
|
|
pub enum Instruction<'a> {
|
|
|
|
/// Push a bunch of data
|
|
|
|
PushBytes(&'a [u8]),
|
|
|
|
/// Some non-push opcode
|
|
|
|
Op(opcodes::All),
|
|
|
|
/// An opcode we were unable to parse
|
|
|
|
Error(Error)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Iterator over a script returning parsed opcodes
|
|
|
|
pub struct Instructions<'a> {
|
|
|
|
data: &'a [u8]
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> IntoIterator for &'a Script {
|
|
|
|
type Item = Instruction<'a>;
|
|
|
|
type IntoIter = Instructions<'a>;
|
|
|
|
fn into_iter(self) -> Instructions<'a> { Instructions { data: &self.0[..] } }
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> Iterator for Instructions<'a> {
|
|
|
|
type Item = Instruction<'a>;
|
|
|
|
|
|
|
|
fn next(&mut self) -> Option<Instruction<'a>> {
|
2015-10-28 16:27:23 +00:00
|
|
|
if self.data.is_empty() {
|
2015-10-15 03:00:47 +00:00
|
|
|
return None;
|
|
|
|
}
|
|
|
|
|
|
|
|
match opcodes::All::from(self.data[0]).classify() {
|
|
|
|
opcodes::Class::PushBytes(n) => {
|
|
|
|
let n = n as usize;
|
|
|
|
if self.data.len() < n + 1 {
|
|
|
|
return Some(Instruction::Error(Error::EarlyEndOfScript));
|
|
|
|
}
|
|
|
|
let ret = Some(Instruction::PushBytes(&self.data[1..n+1]));
|
|
|
|
self.data = &self.data[n + 1..];
|
|
|
|
ret
|
|
|
|
}
|
|
|
|
opcodes::Class::Ordinary(opcodes::Ordinary::OP_PUSHDATA1) => {
|
|
|
|
if self.data.len() < 2 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let n = match read_uint(&self.data[1..], 1) {
|
|
|
|
Ok(n) => n,
|
|
|
|
Err(e) => { return Some(Instruction::Error(e)); }
|
|
|
|
};
|
|
|
|
if self.data.len() < n + 2 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let ret = Some(Instruction::PushBytes(&self.data[2..n+2]));
|
|
|
|
self.data = &self.data[n + 2..];
|
|
|
|
ret
|
|
|
|
}
|
|
|
|
opcodes::Class::Ordinary(opcodes::Ordinary::OP_PUSHDATA2) => {
|
|
|
|
if self.data.len() < 3 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let n = match read_uint(&self.data[1..], 2) {
|
|
|
|
Ok(n) => n,
|
|
|
|
Err(e) => { return Some(Instruction::Error(e)); }
|
|
|
|
};
|
|
|
|
if self.data.len() < n + 3 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let ret = Some(Instruction::PushBytes(&self.data[3..n + 3]));
|
|
|
|
self.data = &self.data[n + 3..];
|
|
|
|
ret
|
|
|
|
}
|
|
|
|
opcodes::Class::Ordinary(opcodes::Ordinary::OP_PUSHDATA4) => {
|
|
|
|
if self.data.len() < 5 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let n = match read_uint(&self.data[1..], 4) {
|
|
|
|
Ok(n) => n,
|
|
|
|
Err(e) => { return Some(Instruction::Error(e)); }
|
|
|
|
};
|
|
|
|
if self.data.len() < n + 5 { return Some(Instruction::Error(Error::EarlyEndOfScript)); }
|
|
|
|
let ret = Some(Instruction::PushBytes(&self.data[5..n + 5]));
|
|
|
|
self.data = &self.data[n + 5..];
|
|
|
|
ret
|
|
|
|
}
|
|
|
|
// Everything else we can push right through
|
|
|
|
_ => {
|
|
|
|
let ret = Some(Instruction::Op(opcodes::All::from(self.data[0])));
|
|
|
|
self.data = &self.data[1..];
|
|
|
|
ret
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-04-10 02:16:30 +00:00
|
|
|
impl Builder {
|
2015-04-07 22:51:57 +00:00
|
|
|
/// Creates a new empty script
|
2015-04-10 02:16:30 +00:00
|
|
|
pub fn new() -> Builder { Builder(vec![]) }
|
2015-04-07 22:51:57 +00:00
|
|
|
|
|
|
|
/// The length in bytes of the script
|
|
|
|
pub fn len(&self) -> usize { self.0.len() }
|
|
|
|
|
2015-10-28 16:27:23 +00:00
|
|
|
/// Whether the script is the empty script
|
|
|
|
pub fn is_empty(&self) -> bool { self.0.is_empty() }
|
|
|
|
|
2015-04-07 22:51:57 +00:00
|
|
|
/// Adds instructions to push an integer onto the stack. Integers are
|
|
|
|
/// encoded as little-endian signed-magnitude numbers, but there are
|
|
|
|
/// dedicated opcodes to push some small integers.
|
2015-11-04 17:04:54 +00:00
|
|
|
pub fn push_int(mut self, data: i64) -> Builder {
|
2015-04-07 22:51:57 +00:00
|
|
|
// We can special-case -1, 1-16
|
2015-05-10 19:32:26 +00:00
|
|
|
if data == -1 || (data >= 1 && data <= 16) {
|
|
|
|
self.0.push((data + opcodes::OP_TRUE as i64) as u8);
|
2015-11-04 17:04:54 +00:00
|
|
|
self
|
2015-04-07 22:51:57 +00:00
|
|
|
}
|
|
|
|
// We can also special-case zero
|
|
|
|
else if data == 0 {
|
|
|
|
self.0.push(opcodes::OP_FALSE as u8);
|
2015-11-04 17:04:54 +00:00
|
|
|
self
|
2015-04-07 22:51:57 +00:00
|
|
|
}
|
|
|
|
// Otherwise encode it as data
|
2015-11-04 17:04:54 +00:00
|
|
|
else { self.push_scriptint(data) }
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
2015-04-07 22:51:57 +00:00
|
|
|
/// Adds instructions to push an integer onto the stack, using the explicit
|
|
|
|
/// encoding regardless of the availability of dedicated opcodes.
|
2015-11-04 17:04:54 +00:00
|
|
|
pub fn push_scriptint(self, data: i64) -> Builder {
|
|
|
|
self.push_slice(&build_scriptint(data))
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
2015-04-07 22:51:57 +00:00
|
|
|
/// Adds instructions to push some arbitrary data onto the stack
|
2015-11-04 17:04:54 +00:00
|
|
|
pub fn push_slice(mut self, data: &[u8]) -> Builder {
|
2015-04-07 22:51:57 +00:00
|
|
|
// Start with a PUSH opcode
|
|
|
|
match data.len() {
|
|
|
|
n if n < opcodes::Ordinary::OP_PUSHDATA1 as usize => { self.0.push(n as u8); },
|
|
|
|
n if n < 0x100 => {
|
|
|
|
self.0.push(opcodes::Ordinary::OP_PUSHDATA1 as u8);
|
|
|
|
self.0.push(n as u8);
|
|
|
|
},
|
|
|
|
n if n < 0x10000 => {
|
|
|
|
self.0.push(opcodes::Ordinary::OP_PUSHDATA2 as u8);
|
|
|
|
self.0.push((n % 0x100) as u8);
|
|
|
|
self.0.push((n / 0x100) as u8);
|
|
|
|
},
|
|
|
|
n if n < 0x100000000 => {
|
|
|
|
self.0.push(opcodes::Ordinary::OP_PUSHDATA4 as u8);
|
|
|
|
self.0.push((n % 0x100) as u8);
|
|
|
|
self.0.push(((n / 0x100) % 0x100) as u8);
|
|
|
|
self.0.push(((n / 0x10000) % 0x100) as u8);
|
|
|
|
self.0.push((n / 0x1000000) as u8);
|
|
|
|
}
|
|
|
|
_ => panic!("tried to put a 4bn+ sized object into a script!")
|
|
|
|
}
|
|
|
|
// Then push the acraw
|
2015-04-11 01:55:59 +00:00
|
|
|
self.0.extend(data.iter().cloned());
|
2015-11-04 17:04:54 +00:00
|
|
|
self
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
2015-04-11 01:55:59 +00:00
|
|
|
/// Adds a single opcode to the script
|
2015-11-04 17:04:54 +00:00
|
|
|
pub fn push_opcode(mut self, data: opcodes::All) -> Builder {
|
2015-04-07 22:51:57 +00:00
|
|
|
self.0.push(data as u8);
|
2015-11-04 17:04:54 +00:00
|
|
|
self
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
2015-04-11 01:55:59 +00:00
|
|
|
/// Converts the `Builder` into an unmodifiable `Script`
|
2015-04-07 22:51:57 +00:00
|
|
|
pub fn into_script(self) -> Script {
|
|
|
|
Script(self.0.into_boxed_slice())
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-23 23:20:46 +00:00
|
|
|
}
|
|
|
|
|
2015-04-07 22:51:57 +00:00
|
|
|
/// Adds an individual opcode to the script
|
2015-04-10 02:16:30 +00:00
|
|
|
impl Default for Builder {
|
|
|
|
fn default() -> Builder { Builder(vec![]) }
|
2015-04-07 22:51:57 +00:00
|
|
|
}
|
|
|
|
|
2015-10-14 13:56:48 +00:00
|
|
|
/// Creates a new script from an existing vector
|
|
|
|
impl From<Vec<u8>> for Builder {
|
|
|
|
fn from(v: Vec<u8>) -> Builder { Builder(v) }
|
|
|
|
}
|
|
|
|
|
2015-04-10 02:16:30 +00:00
|
|
|
impl_index_newtype!(Builder, u8);
|
2015-04-07 22:51:57 +00:00
|
|
|
|
2014-07-29 03:12:10 +00:00
|
|
|
// User-facing serialization
|
2015-04-06 00:10:37 +00:00
|
|
|
impl serde::Serialize for Script {
|
2015-11-30 13:09:39 +00:00
|
|
|
fn serialize<S>(&self, s: &mut S) -> Result<(), S::Error>
|
2015-04-07 01:51:11 +00:00
|
|
|
where S: serde::Serializer,
|
|
|
|
{
|
2015-11-30 13:09:39 +00:00
|
|
|
s.visit_str(&format!("{:x}", self))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl serde::Deserialize for Script {
|
|
|
|
fn deserialize<D>(d: &mut D) -> Result<Script, D::Error>
|
|
|
|
where D: serde::Deserializer
|
|
|
|
{
|
|
|
|
use serialize::hex::FromHex;
|
|
|
|
|
|
|
|
struct ScriptVisitor;
|
|
|
|
impl serde::de::Visitor for ScriptVisitor {
|
|
|
|
type Value = Script;
|
|
|
|
|
|
|
|
fn visit_string<E>(&mut self, v: String) -> Result<Script, E>
|
|
|
|
where E: serde::de::Error
|
|
|
|
{
|
|
|
|
self.visit_str(&v)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn visit_str<E>(&mut self, hex_str: &str) -> Result<Script, E>
|
|
|
|
where E: serde::de::Error
|
|
|
|
{
|
|
|
|
let raw_vec: Vec<u8> = try!(hex_str.from_hex()
|
|
|
|
.map_err(|_| serde::de::Error::syntax("bad script hex")));
|
|
|
|
Ok(Script::from(raw_vec))
|
|
|
|
}
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2015-11-30 13:09:39 +00:00
|
|
|
|
|
|
|
d.visit(ScriptVisitor)
|
2014-07-29 03:12:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Network serialization
|
2015-04-06 00:10:37 +00:00
|
|
|
impl<S: SimpleEncoder> ConsensusEncodable<S> for Script {
|
2015-04-07 01:51:11 +00:00
|
|
|
#[inline]
|
|
|
|
fn consensus_encode(&self, s: &mut S) -> Result<(), S::Error> {
|
2015-04-07 22:51:57 +00:00
|
|
|
self.0.consensus_encode(s)
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2014-08-01 16:01:39 +00:00
|
|
|
}
|
2014-07-18 13:56:17 +00:00
|
|
|
|
2015-04-06 00:10:37 +00:00
|
|
|
impl<D: SimpleDecoder> ConsensusDecodable<D> for Script {
|
2015-04-07 01:51:11 +00:00
|
|
|
#[inline]
|
|
|
|
fn consensus_decode(d: &mut D) -> Result<Script, D::Error> {
|
|
|
|
Ok(Script(try!(ConsensusDecodable::consensus_decode(d))))
|
|
|
|
}
|
2014-07-18 13:56:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod test {
|
2015-04-07 01:51:11 +00:00
|
|
|
use serialize::hex::FromHex;
|
|
|
|
|
2015-10-15 03:00:47 +00:00
|
|
|
use super::*;
|
|
|
|
use super::build_scriptint;
|
2015-04-07 01:51:11 +00:00
|
|
|
|
|
|
|
use network::serialize::{deserialize, serialize};
|
|
|
|
use blockdata::opcodes;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn script() {
|
|
|
|
let mut comp = vec![];
|
2015-04-10 02:16:30 +00:00
|
|
|
let mut script = Builder::new();
|
2015-04-08 22:23:45 +00:00
|
|
|
assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
|
|
|
|
// small ints
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_int(1); comp.push(82u8); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_int(0); comp.push(0u8); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_int(4); comp.push(85u8); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_int(-1); comp.push(80u8); assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
// forced scriptint
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_scriptint(4); comp.extend([1u8, 4].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
// big ints
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_int(17); comp.extend([1u8, 17].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_int(10000); comp.extend([2u8, 16, 39].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
// notice the sign bit set here, hence the extra zero/128 at the end
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_int(10000000); comp.extend([4u8, 128, 150, 152, 0].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_int(-10000000); comp.extend([4u8, 128, 150, 152, 128].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
|
|
|
|
// data
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_slice("NRA4VR".as_bytes()); comp.extend([6u8, 78, 82, 65, 52, 86, 82].iter().cloned()); assert_eq!(&script[..], &comp[..]);
|
2015-04-07 01:51:11 +00:00
|
|
|
|
|
|
|
// opcodes
|
2015-11-04 17:04:54 +00:00
|
|
|
script = script.push_opcode(opcodes::All::OP_CHECKSIG); comp.push(0xACu8); assert_eq!(&script[..], &comp[..]);
|
|
|
|
script = script.push_opcode(opcodes::All::OP_CHECKSIG); comp.push(0xACu8); assert_eq!(&script[..], &comp[..]);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn script_builder() {
|
|
|
|
// from txid 3bb5e6434c11fb93f64574af5d116736510717f2c595eb45b52c28e31622dfff which was in my mempool when I wrote the test
|
|
|
|
let script = Builder::new().push_opcode(opcodes::All::OP_DUP)
|
|
|
|
.push_opcode(opcodes::All::OP_HASH160)
|
|
|
|
.push_slice(&"16e1ae70ff0fa102905d4af297f6912bda6cce19".from_hex().unwrap())
|
|
|
|
.push_opcode(opcodes::All::OP_EQUALVERIFY)
|
|
|
|
.push_opcode(opcodes::All::OP_CHECKSIG)
|
|
|
|
.into_script();
|
|
|
|
assert_eq!(&format!("{:x}", script), "76a91416e1ae70ff0fa102905d4af297f6912bda6cce1988ac");
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn script_serialize() {
|
|
|
|
let hex_script = "6c493046022100f93bb0e7d8db7bd46e40132d1f8242026e045f03a0efe71bbb8e3f475e970d790221009337cd7f1f929f00cc6ff01f03729b069a7c21b59b1736ddfee5db5946c5da8c0121033b9b137ee87d5a812d6f506efdd37f0affa7ffc310711c06c7f3e097c9447c52".from_hex().unwrap();
|
2015-04-08 22:23:45 +00:00
|
|
|
let script: Result<Script, _> = deserialize(&hex_script);
|
2015-04-07 01:51:11 +00:00
|
|
|
assert!(script.is_ok());
|
2015-04-08 22:23:45 +00:00
|
|
|
assert_eq!(serialize(&script.unwrap()).ok(), Some(hex_script));
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn scriptint_round_trip() {
|
|
|
|
assert_eq!(build_scriptint(-1), vec![0x81]);
|
|
|
|
assert_eq!(build_scriptint(255), vec![255, 0]);
|
|
|
|
assert_eq!(build_scriptint(256), vec![0, 1]);
|
|
|
|
assert_eq!(build_scriptint(257), vec![1, 1]);
|
|
|
|
assert_eq!(build_scriptint(511), vec![255, 1]);
|
|
|
|
for &i in [10, 100, 255, 256, 1000, 10000, 25000, 200000, 5000000, 1000000000,
|
|
|
|
(1 << 31) - 1, -((1 << 31) - 1)].iter() {
|
|
|
|
assert_eq!(Ok(i), read_scriptint(&build_scriptint(i)));
|
|
|
|
assert_eq!(Ok(-i), read_scriptint(&build_scriptint(-i)));
|
|
|
|
}
|
|
|
|
assert!(read_scriptint(&build_scriptint(1 << 31)).is_err());
|
|
|
|
assert!(read_scriptint(&build_scriptint(-(1 << 31))).is_err());
|
|
|
|
}
|
|
|
|
|
2015-11-30 13:09:39 +00:00
|
|
|
macro_rules! hex_script (($s:expr) => (Script::from($s.from_hex().unwrap())));
|
|
|
|
|
2015-04-07 01:51:11 +00:00
|
|
|
#[test]
|
|
|
|
fn provably_unspendable_test() {
|
|
|
|
// p2pk
|
2015-11-30 13:09:39 +00:00
|
|
|
assert_eq!(hex_script!("410446ef0102d1ec5240f0d061a4246c1bdef63fc3dbab7733052fbbf0ecd8f41fc26bf049ebb4f9527f374280259e7cfa99c48b0e3f39c51347a19a5819651503a5ac").is_provably_unspendable(), false);
|
|
|
|
assert_eq!(hex_script!("4104ea1feff861b51fe3f5f8a3b12d0f4712db80e919548a80839fc47c6a21e66d957e9c5d8cd108c7a2d2324bad71f9904ac0ae7336507d785b17a2c115e427a32fac").is_provably_unspendable(), false);
|
2015-04-07 01:51:11 +00:00
|
|
|
// p2pkhash
|
2015-11-30 13:09:39 +00:00
|
|
|
assert_eq!(hex_script!("76a914ee61d57ab51b9d212335b1dba62794ac20d2bcf988ac").is_provably_unspendable(), false);
|
|
|
|
assert_eq!(hex_script!("6aa9149eb21980dc9d413d8eac27314938b9da920ee53e87").is_provably_unspendable(), true);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn script_json_serialize() {
|
|
|
|
use strason;
|
|
|
|
|
|
|
|
let original = hex_script!("827651a0698faaa9a8a7a687");
|
|
|
|
let json = strason::from_serialize(&original).unwrap();
|
|
|
|
assert_eq!(json.to_bytes(), b"\"827651a0698faaa9a8a7a687\"");
|
|
|
|
assert_eq!(json.string(), Some("827651a0698faaa9a8a7a687"));
|
|
|
|
let des = json.into_deserialize().unwrap();
|
|
|
|
assert_eq!(original, des);
|
2015-04-07 01:51:11 +00:00
|
|
|
}
|
2015-12-04 16:59:43 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn script_debug_display() {
|
|
|
|
assert_eq!(format!("{:?}", hex_script!("6363636363686868686800")),
|
|
|
|
"Script(OP_IF OP_IF OP_IF OP_IF OP_IF OP_ENDIF OP_ENDIF OP_ENDIF OP_ENDIF OP_ENDIF OP_0)");
|
|
|
|
assert_eq!(format!("{}", hex_script!("6363636363686868686800")),
|
|
|
|
"Script(OP_IF OP_IF OP_IF OP_IF OP_IF OP_ENDIF OP_ENDIF OP_ENDIF OP_ENDIF OP_ENDIF OP_0)");
|
|
|
|
assert_eq!(format!("{}", hex_script!("2102715e91d37d239dea832f1460e91e368115d8ca6cc23a7da966795abad9e3b699ac")),
|
|
|
|
"Script(OP_PUSHBYTES_33 02715e91d37d239dea832f1460e91e368115d8ca6cc23a7da966795abad9e3b699 OP_CHECKSIG)");
|
|
|
|
}
|
2014-07-18 13:56:17 +00:00
|
|
|
}
|
|
|
|
|