parity-zcash/script/src/script.rs

704 lines
22 KiB
Rust

//! Serialized script, used inside transaction inputs and outputs.
use bytes::Bytes;
use std::{fmt, ops};
use zebra_keys::{self, AddressHash, Public};
use {Error, Opcode};
/// Maximum number of bytes pushable to the stack
pub const MAX_SCRIPT_ELEMENT_SIZE: usize = 520;
/// Maximum number of non-push operations per script
pub const MAX_OPS_PER_SCRIPT: u32 = 201;
/// Maximum number of public keys per multisig
pub const MAX_PUBKEYS_PER_MULTISIG: usize = 20;
/// Maximum script length in bytes
pub const MAX_SCRIPT_SIZE: usize = 10000;
/// Classified script type
#[derive(PartialEq, Debug)]
pub enum ScriptType {
NonStandard,
PubKey,
PubKeyHash,
ScriptHash,
Multisig,
NullData,
}
/// Address from Script
#[derive(PartialEq, Debug)]
pub struct ScriptAddress {
/// The type of the address.
pub kind: zebra_keys::Type,
/// Public key hash.
pub hash: AddressHash,
}
impl ScriptAddress {
/// Creates P2PKH-type ScriptAddress
pub fn new_p2pkh(hash: AddressHash) -> Self {
ScriptAddress {
kind: zebra_keys::Type::P2PKH,
hash: hash,
}
}
/// Creates P2SH-type ScriptAddress
pub fn new_p2sh(hash: AddressHash) -> Self {
ScriptAddress {
kind: zebra_keys::Type::P2SH,
hash: hash,
}
}
}
/// Serialized script, used inside transaction inputs and outputs.
#[derive(PartialEq, Debug)]
pub struct Script {
data: Bytes,
}
impl From<&'static str> for Script {
fn from(s: &'static str) -> Self {
Script::new(s.into())
}
}
impl From<Bytes> for Script {
fn from(s: Bytes) -> Self {
Script::new(s)
}
}
impl From<Vec<u8>> for Script {
fn from(v: Vec<u8>) -> Self {
Script::new(v.into())
}
}
impl From<Script> for Bytes {
fn from(script: Script) -> Self {
script.data
}
}
impl Script {
/// Script constructor.
pub fn new(data: Bytes) -> Self {
Script { data: data }
}
pub fn to_bytes(&self) -> Bytes {
self.data.clone()
}
/// Is empty script
pub fn is_empty(&self) -> bool {
self.data.len() == 0
}
/// Extra-fast test for pay-to-public-key-hash (P2PKH) scripts.
pub fn is_pay_to_public_key_hash(&self) -> bool {
self.data.len() == 25
&& self.data[0] == Opcode::OP_DUP as u8
&& self.data[1] == Opcode::OP_HASH160 as u8
&& self.data[2] == Opcode::OP_PUSHBYTES_20 as u8
&& self.data[23] == Opcode::OP_EQUALVERIFY as u8
&& self.data[24] == Opcode::OP_CHECKSIG as u8
}
/// Extra-fast test for pay-to-public-key (P2PK) scripts.
pub fn is_pay_to_public_key(&self) -> bool {
if self.data.is_empty() {
return false;
}
let len = match self.data[0] {
x if x == Opcode::OP_PUSHBYTES_33 as u8 => 35,
x if x == Opcode::OP_PUSHBYTES_65 as u8 => 67,
_ => return false,
};
self.data.len() == len && self.data[len - 1] == Opcode::OP_CHECKSIG as u8
}
/// Extra-fast test for pay-to-script-hash (P2SH) scripts.
pub fn is_pay_to_script_hash(&self) -> bool {
self.data.len() == 23
&& self.data[0] == Opcode::OP_HASH160 as u8
&& self.data[1] == Opcode::OP_PUSHBYTES_20 as u8
&& self.data[22] == Opcode::OP_EQUAL as u8
}
/// Extra-fast test for multisig scripts.
pub fn is_multisig_script(&self) -> bool {
if self.data.len() < 3 {
return false;
}
let siglen = match self.get_opcode(0) {
Ok(Opcode::OP_0) => 0,
Ok(o) if o >= Opcode::OP_1 && o <= Opcode::OP_16 => o as u8 - (Opcode::OP_1 as u8 - 1),
_ => return false,
};
let keylen = match self.get_opcode(self.data.len() - 2) {
Ok(Opcode::OP_0) => 0,
Ok(o) if o >= Opcode::OP_1 && o <= Opcode::OP_16 => o as u8 - (Opcode::OP_1 as u8 - 1),
_ => return false,
};
if siglen > keylen {
return false;
}
if self.data[self.data.len() - 1] != Opcode::OP_CHECKMULTISIG as u8 {
return false;
}
let mut pc = 1;
let mut keys = 0;
while pc < self.len() - 2 {
let instruction = match self.get_instruction(pc) {
Ok(i) => i,
_ => return false,
};
match instruction.opcode {
Opcode::OP_PUSHBYTES_33 | Opcode::OP_PUSHBYTES_65 => keys += 1,
_ => return false,
}
pc += instruction.step;
}
keys == keylen
}
pub fn is_null_data_script(&self) -> bool {
// TODO: optimise it
!self.data.is_empty()
&& self.data[0] == Opcode::OP_RETURN as u8
&& self.subscript(1).is_push_only()
}
pub fn subscript(&self, from: usize) -> Script {
self.data[from..].to_vec().into()
}
pub fn get_opcode(&self, position: usize) -> Result<Opcode, Error> {
Opcode::from_u8(self.data[position]).ok_or(Error::BadOpcode)
}
pub fn get_instruction(&self, position: usize) -> Result<Instruction, Error> {
let opcode = self.get_opcode(position)?;
let instruction = match opcode {
Opcode::OP_PUSHDATA1 | Opcode::OP_PUSHDATA2 | Opcode::OP_PUSHDATA4 => {
let len = match opcode {
Opcode::OP_PUSHDATA1 => 1,
Opcode::OP_PUSHDATA2 => 2,
_ => 4,
};
let slice = self.take(position + 1, len)?;
let n = read_usize(slice, len)?;
let bytes = self.take(position + 1 + len, n)?;
Instruction {
opcode: opcode,
step: len + n + 1,
data: Some(bytes),
}
}
o if o <= Opcode::OP_PUSHBYTES_75 => {
let bytes = self.take(position + 1, opcode as usize)?;
Instruction {
opcode: o,
step: opcode as usize + 1,
data: Some(bytes),
}
}
_ => Instruction {
opcode: opcode,
step: 1,
data: None,
},
};
Ok(instruction)
}
#[inline]
pub fn take(&self, offset: usize, len: usize) -> Result<&[u8], Error> {
if offset + len > self.data.len() {
Err(Error::BadOpcode)
} else {
Ok(&self.data[offset..offset + len])
}
}
/// Returns true if script contains only push opcodes
pub fn is_push_only(&self) -> bool {
let mut pc = 0;
while pc < self.len() {
let instruction = match self.get_instruction(pc) {
Ok(i) => i,
_ => return false,
};
if instruction.opcode > Opcode::OP_16 {
return false;
}
pc += instruction.step;
}
true
}
pub fn script_type(&self) -> ScriptType {
if self.is_pay_to_public_key() {
ScriptType::PubKey
} else if self.is_pay_to_public_key_hash() {
ScriptType::PubKeyHash
} else if self.is_pay_to_script_hash() {
ScriptType::ScriptHash
} else if self.is_multisig_script() {
ScriptType::Multisig
} else if self.is_null_data_script() {
ScriptType::NullData
} else {
ScriptType::NonStandard
}
}
pub fn iter(&self) -> Instructions {
Instructions {
position: 0,
script: self,
}
}
pub fn opcodes(&self) -> Opcodes {
Opcodes {
position: 0,
script: self,
}
}
pub fn sigops_count(&self, serialized_script: bool) -> usize {
let mut last_opcode = Opcode::OP_0;
let mut total = 0;
for opcode in self.opcodes() {
let opcode = match opcode {
Ok(opcode) => opcode,
// If we push an invalid element, all previous CHECKSIGs are counted
_ => return total,
};
match opcode {
Opcode::OP_CHECKSIG | Opcode::OP_CHECKSIGVERIFY => {
total += 1;
}
Opcode::OP_CHECKMULTISIG | Opcode::OP_CHECKMULTISIGVERIFY => {
if serialized_script && last_opcode.is_within_op_n() {
total += last_opcode.decode_op_n() as usize;
} else {
total += MAX_PUBKEYS_PER_MULTISIG;
}
}
_ => (),
};
last_opcode = opcode;
}
total
}
pub fn num_signatures_required(&self) -> u8 {
if self.is_multisig_script() {
return match self.data[0] {
x if x == Opcode::OP_0 as u8 => 0,
x => x - (Opcode::OP_1 as u8) + 1,
};
}
return 1;
}
pub fn extract_destinations(&self) -> Result<Vec<ScriptAddress>, zebra_keys::Error> {
match self.script_type() {
ScriptType::NonStandard => Ok(vec![]),
ScriptType::PubKey => {
Public::from_slice(match self.data[0] {
x if x == Opcode::OP_PUSHBYTES_33 as u8 => &self.data[1..34],
x if x == Opcode::OP_PUSHBYTES_65 as u8 => &self.data[1..66],
_ => unreachable!(), // because we are relying on script_type() checks here
})
.map(|public| vec![ScriptAddress::new_p2pkh(public.address_hash())])
}
ScriptType::PubKeyHash => Ok(vec![ScriptAddress::new_p2pkh(self.data[3..23].into())]),
ScriptType::ScriptHash => Ok(vec![ScriptAddress::new_p2sh(self.data[2..22].into())]),
ScriptType::Multisig => {
let mut addresses: Vec<ScriptAddress> = Vec::new();
let mut pc = 1;
while pc < self.len() - 2 {
let instruction = self
.get_instruction(pc)
.expect("this method depends on previous check in script_type()");
let data = instruction
.data
.expect("this method depends on previous check in script_type()");
let address = Public::from_slice(data)?.address_hash();
addresses.push(ScriptAddress::new_p2pkh(address));
pc += instruction.step;
}
Ok(addresses)
}
ScriptType::NullData => Ok(vec![]),
}
}
pub fn pay_to_script_hash_sigops(&self, prev_out: &Script) -> usize {
if !prev_out.is_pay_to_script_hash() {
return 0;
}
if self.data.is_empty() || !self.is_push_only() {
return 0;
}
let script: Script = self
.iter()
.last()
.expect("self.data.is_empty() == false; qed")
.expect("self.data.is_push_only()")
.data
.expect("self.data.is_push_only()")
.to_vec()
.into();
script.sigops_count(true)
}
}
pub struct Instructions<'a> {
position: usize,
script: &'a Script,
}
pub struct Opcodes<'a> {
position: usize,
script: &'a Script,
}
impl<'a> Iterator for Instructions<'a> {
type Item = Result<Instruction<'a>, Error>;
fn next(&mut self) -> Option<Result<Instruction<'a>, Error>> {
if self.script.len() <= self.position {
return None;
}
let instruction = match self.script.get_instruction(self.position) {
Ok(x) => x,
Err(e) => return Some(Err(e)),
};
self.position += instruction.step;
Some(Ok(instruction))
}
}
impl<'a> Iterator for Opcodes<'a> {
type Item = Result<Opcode, Error>;
fn next(&mut self) -> Option<Result<Opcode, Error>> {
if self.script.len() <= self.position {
return None;
}
let instruction = match self.script.get_instruction(self.position) {
Ok(x) => x,
Err(e) => return Some(Err(e)),
};
self.position += instruction.step;
Some(Ok(instruction.opcode))
}
}
impl ops::Deref for Script {
type Target = [u8];
fn deref(&self) -> &Self::Target {
&self.data
}
}
pub struct Instruction<'a> {
pub opcode: Opcode,
pub step: usize,
pub data: Option<&'a [u8]>,
}
fn read_usize(data: &[u8], size: usize) -> Result<usize, Error> {
if data.len() < size {
return Err(Error::BadOpcode);
}
let result = data
.iter()
.take(size)
.enumerate()
.fold(0, |acc, (i, x)| acc + ((*x as usize) << (i * 8)));
Ok(result)
}
impl fmt::Display for Script {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut pc = 0;
while pc < self.len() {
let instruction = match self.get_instruction(pc) {
Ok(i) => i,
Err(e) => return e.fmt(f),
};
match instruction.data {
Some(data) => writeln!(
f,
"{:?} 0x{:?}",
instruction.opcode,
Bytes::from(data.to_vec())
)?,
None => writeln!(f, "{:?}", instruction.opcode)?,
}
pc += instruction.step;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::{Script, ScriptAddress, ScriptType, MAX_SCRIPT_ELEMENT_SIZE};
use zebra_keys::{Address, Public};
use {Builder, Opcode};
#[test]
fn test_is_pay_to_script_hash() {
let script: Script = "a9143b80842f4ea32806ce5e723a255ddd6490cfd28d87".into();
let script2: Script = "a9143b80842f4ea32806ce5e723a255ddd6490cfd28d88".into();
assert!(script.is_pay_to_script_hash());
assert!(!script2.is_pay_to_script_hash());
}
#[test]
fn test_script_debug() {
use std::fmt::Write;
let script = Builder::default()
.push_num(3.into())
.push_num(2.into())
.push_opcode(Opcode::OP_ADD)
.into_script();
let s = "Script { data: 0103010293 }";
let mut res = String::new();
write!(&mut res, "{:?}", script).unwrap();
assert_eq!(s.to_string(), res);
}
#[test]
fn test_script_display() {
let script = Builder::default()
.push_num(3.into())
.push_num(2.into())
.push_opcode(Opcode::OP_ADD)
.into_script();
let s = r#"OP_PUSHBYTES_1 0x03
OP_PUSHBYTES_1 0x02
OP_ADD
"#;
assert_eq!(script.to_string(), s.to_string());
}
#[test]
fn test_script_is_multisig() {
let script: Script = "524104a882d414e478039cd5b52a92ffb13dd5e6bd4515497439dffd691a0f12af9575fa349b5694ed3155b136f09e63975a1700c9f4d4df849323dac06cf3bd6458cd41046ce31db9bdd543e72fe3039a1f1c047dab87037c36a669ff90e28da1848f640de68c2fe913d363a51154a0c62d7adea1b822d05035077418267b1a1379790187410411ffd36c70776538d079fbae117dc38effafb33304af83ce4894589747aee1ef992f63280567f52f5ba870678b4ab4ff6c8ea600bd217870a8b4f1f09f3a8e8353ae".into();
let not: Script =
"ab00270025512102e485fdaa062387c0bbb5ab711a093b6635299ec155b7b852fce6b992d5adbfec51ae"
.into();
assert!(script.is_multisig_script());
assert!(!not.is_multisig_script());
}
// https://github.com/libbtc/libbtc/blob/998badcdac95a226a8f8c00c8f6abbd8a77917c1/test/tx_tests.c#L640
#[test]
fn test_script_type() {
assert_eq!(
ScriptType::PubKeyHash,
Script::from("76a914aab76ba4877d696590d94ea3e02948b55294815188ac").script_type()
);
assert_eq!(ScriptType::Multisig, Script::from("522102004525da5546e7603eefad5ef971e82f7dad2272b34e6b3036ab1fe3d299c22f21037d7f2227e6c646707d1c61ecceb821794124363a2cf2c1d2a6f28cf01e5d6abe52ae").script_type());
assert_eq!(
ScriptType::ScriptHash,
Script::from("a9146262b64aec1f4a4c1d21b32e9c2811dd2171fd7587").script_type()
);
assert_eq!(ScriptType::PubKey, Script::from("4104ae1a62fe09c5f51b13905f07f06b99a2f7159b2225f374cd378d71302fa28414e7aab37397f554a7df5f142c21c1b7303b8a0626f1baded5c72a704f7e6cd84cac").script_type());
}
#[test]
fn test_sigops_count() {
assert_eq!(
1usize,
Script::from("76a914aab76ba4877d696590d94ea3e02948b55294815188ac").sigops_count(false)
);
assert_eq!(2usize, Script::from("522102004525da5546e7603eefad5ef971e82f7dad2272b34e6b3036ab1fe3d299c22f21037d7f2227e6c646707d1c61ecceb821794124363a2cf2c1d2a6f28cf01e5d6abe52ae").sigops_count(true));
assert_eq!(20usize, Script::from("522102004525da5546e7603eefad5ef971e82f7dad2272b34e6b3036ab1fe3d299c22f21037d7f2227e6c646707d1c61ecceb821794124363a2cf2c1d2a6f28cf01e5d6abe52ae").sigops_count(false));
assert_eq!(
0usize,
Script::from("a9146262b64aec1f4a4c1d21b32e9c2811dd2171fd7587").sigops_count(false)
);
assert_eq!(1usize, Script::from("4104ae1a62fe09c5f51b13905f07f06b99a2f7159b2225f374cd378d71302fa28414e7aab37397f554a7df5f142c21c1b7303b8a0626f1baded5c72a704f7e6cd84cac").sigops_count(false));
}
#[test]
fn test_sigops_count_b73() {
let max_block_sigops = 20000;
let block_sigops = 0;
let mut script = vec![
Opcode::OP_CHECKSIG as u8;
max_block_sigops - block_sigops + MAX_SCRIPT_ELEMENT_SIZE + 1 + 5 + 1
];
script[max_block_sigops - block_sigops] = Opcode::OP_PUSHDATA4 as u8;
let overmax = MAX_SCRIPT_ELEMENT_SIZE + 1;
script[max_block_sigops - block_sigops + 1] = overmax as u8;
script[max_block_sigops - block_sigops + 2] = (overmax >> 8) as u8;
script[max_block_sigops - block_sigops + 3] = (overmax >> 16) as u8;
script[max_block_sigops - block_sigops + 4] = (overmax >> 24) as u8;
let script: Script = script.into();
assert_eq!(script.sigops_count(false), 20001);
}
#[test]
fn test_sigops_count_b74() {
let max_block_sigops = 20000;
let block_sigops = 0;
let mut script = vec![
Opcode::OP_CHECKSIG as u8;
max_block_sigops - block_sigops + MAX_SCRIPT_ELEMENT_SIZE + 42
];
script[max_block_sigops - block_sigops + 1] = Opcode::OP_PUSHDATA4 as u8;
script[max_block_sigops - block_sigops + 2] = 0xfe;
script[max_block_sigops - block_sigops + 3] = 0xff;
script[max_block_sigops - block_sigops + 4] = 0xff;
script[max_block_sigops - block_sigops + 5] = 0xff;
let script: Script = script.into();
assert_eq!(script.sigops_count(false), 20001);
}
#[test]
fn test_extract_destinations_pub_key_compressed() {
let pubkey_bytes = [0; 33];
let address = Public::from_slice(&pubkey_bytes).unwrap().address_hash();
let script = Builder::default()
.push_bytes(&pubkey_bytes)
.push_opcode(Opcode::OP_CHECKSIG)
.into_script();
assert_eq!(script.script_type(), ScriptType::PubKey);
assert_eq!(
script.extract_destinations(),
Ok(vec![ScriptAddress::new_p2pkh(address),])
);
}
#[test]
fn test_extract_destinations_pub_key_normal() {
let pubkey_bytes = [0; 65];
let address = Public::from_slice(&pubkey_bytes).unwrap().address_hash();
let script = Builder::default()
.push_bytes(&pubkey_bytes)
.push_opcode(Opcode::OP_CHECKSIG)
.into_script();
assert_eq!(script.script_type(), ScriptType::PubKey);
assert_eq!(
script.extract_destinations(),
Ok(vec![ScriptAddress::new_p2pkh(address),])
);
}
#[test]
fn test_extract_destinations_pub_key_hash() {
let address = Address::from("t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi").hash;
let script = Builder::build_p2pkh(&address);
assert_eq!(script.script_type(), ScriptType::PubKeyHash);
assert_eq!(
script.extract_destinations(),
Ok(vec![ScriptAddress::new_p2pkh(address),])
);
}
#[test]
fn test_extract_destinations_script_hash() {
let address = Address::from("t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi").hash;
let script = Builder::build_p2sh(&address);
assert_eq!(script.script_type(), ScriptType::ScriptHash);
assert_eq!(
script.extract_destinations(),
Ok(vec![ScriptAddress::new_p2sh(address),])
);
}
#[test]
fn test_extract_destinations_multisig() {
let pubkey1_bytes = [0; 33];
let address1 = Public::from_slice(&pubkey1_bytes).unwrap().address_hash();
let pubkey2_bytes = [1; 65];
let address2 = Public::from_slice(&pubkey2_bytes).unwrap().address_hash();
let script = Builder::default()
.push_opcode(Opcode::OP_2)
.push_bytes(&pubkey1_bytes)
.push_bytes(&pubkey2_bytes)
.push_opcode(Opcode::OP_2)
.push_opcode(Opcode::OP_CHECKMULTISIG)
.into_script();
assert_eq!(script.script_type(), ScriptType::Multisig);
assert_eq!(
script.extract_destinations(),
Ok(vec![
ScriptAddress::new_p2pkh(address1),
ScriptAddress::new_p2pkh(address2),
])
);
}
#[test]
fn test_num_signatures_required() {
let script = Builder::default()
.push_opcode(Opcode::OP_3)
.push_bytes(&[0; 33])
.push_bytes(&[0; 65])
.push_bytes(&[0; 65])
.push_bytes(&[0; 65])
.push_opcode(Opcode::OP_4)
.push_opcode(Opcode::OP_CHECKMULTISIG)
.into_script();
assert_eq!(script.script_type(), ScriptType::Multisig);
assert_eq!(script.num_signatures_required(), 3);
let script = Builder::default()
.push_opcode(Opcode::OP_HASH160)
.push_bytes(&[0; 20])
.push_opcode(Opcode::OP_EQUAL)
.into_script();
assert_eq!(script.script_type(), ScriptType::ScriptHash);
assert_eq!(script.num_signatures_required(), 1);
}
}