1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
pub mod op_codes;
use crate::OpCodes::OP_0;
use crate::OpCodes::OP_1;
use crate::VarIntReader;
pub use op_codes::*;
use strum_macros::Display;
use crate::utils::{from_hex, to_hex};
use std::{
io::{Cursor, Read},
str::FromStr,
usize,
};
use crate::{BSVErrors, VarInt};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use num_traits::{FromPrimitive, ToPrimitive};
use serde::{Deserialize, Serialize};
#[cfg(target_arch = "wasm32")]
use wasm_bindgen::{prelude::*, throw_str};
mod script_template;
pub use script_template::*;
#[derive(Debug, Clone, Display, PartialEq, Eq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ScriptBit {
OpCode(OpCodes),
Push(#[serde(serialize_with = "to_hex", deserialize_with = "from_hex")] Vec<u8>),
PushData(OpCodes, #[serde(serialize_with = "to_hex", deserialize_with = "from_hex")] Vec<u8>),
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Script(pub(crate) Vec<ScriptBit>);
impl Script {
pub(crate) fn to_asm_string_impl(&self, extended: bool) -> String {
self.0
.iter()
.map(|x| match x {
ScriptBit::OpCode(OP_0) => match extended {
true => OP_0.to_string(),
false => 0.to_string(),
},
ScriptBit::Push(bytes) => match extended {
true => format!("OP_PUSH {} {}", bytes.len(), hex::encode(bytes)),
false => hex::encode(bytes),
},
ScriptBit::PushData(code, bytes) => match extended {
true => format!("{} {} {}", code, bytes.len(), hex::encode(bytes)),
false => hex::encode(bytes),
},
ScriptBit::OpCode(code) => code.to_string(),
})
.collect::<Vec<String>>()
.join(" ")
}
}
impl Script {
pub(crate) fn from_hex_impl(hex: &str) -> Result<Script, BSVErrors> {
Script::from_bytes_impl(&hex::decode(hex)?)
}
pub(crate) fn from_bytes_impl(bytes: &[u8]) -> Result<Script, BSVErrors> {
let mut cursor = Cursor::new(bytes);
let mut bit_accumulator = vec![];
while let Ok(byte) = cursor.read_u8() {
if (0x01..=0x4b).contains(&byte) {
let mut data = vec![0; byte as usize];
if let Err(e) = cursor.read(&mut data) {
return Err(BSVErrors::DeserialiseScript(format!("Failed to read OP_PUSH data {}", e.to_string())));
}
bit_accumulator.push(ScriptBit::Push(data));
continue;
}
let bit = match OpCodes::from_u8(byte) {
Some(v @ (OpCodes::OP_PUSHDATA1 | OpCodes::OP_PUSHDATA2 | OpCodes::OP_PUSHDATA4)) => {
let data_length = match v {
OpCodes::OP_PUSHDATA1 => cursor.read_u8()? as usize,
OpCodes::OP_PUSHDATA2 => cursor.read_u16::<LittleEndian>()? as usize,
_ => cursor.read_u32::<LittleEndian>()? as usize,
};
let mut data = vec![0; data_length];
if let Err(e) = cursor.read(&mut data) {
return Err(BSVErrors::DeserialiseScript(format!("Failed to read OP_PUSHDATA data {}", e.to_string())));
}
ScriptBit::PushData(v, data)
}
Some(v) => ScriptBit::OpCode(v),
None => return Err(BSVErrors::DeserialiseScript(format!("Unknown opcode {}", byte))),
};
bit_accumulator.push(bit);
}
Ok(Script(bit_accumulator))
}
fn map_string_to_script_bit(code: &str) -> Result<ScriptBit, BSVErrors> {
match code {
"0" => return Ok(ScriptBit::OpCode(OpCodes::OP_0)),
"1" => return Ok(ScriptBit::OpCode(OpCodes::OP_1)),
"2" => return Ok(ScriptBit::OpCode(OpCodes::OP_2)),
"3" => return Ok(ScriptBit::OpCode(OpCodes::OP_3)),
"4" => return Ok(ScriptBit::OpCode(OpCodes::OP_4)),
"5" => return Ok(ScriptBit::OpCode(OpCodes::OP_5)),
"6" => return Ok(ScriptBit::OpCode(OpCodes::OP_6)),
"7" => return Ok(ScriptBit::OpCode(OpCodes::OP_7)),
"8" => return Ok(ScriptBit::OpCode(OpCodes::OP_8)),
"9" => return Ok(ScriptBit::OpCode(OpCodes::OP_9)),
"10" => return Ok(ScriptBit::OpCode(OpCodes::OP_10)),
"11" => return Ok(ScriptBit::OpCode(OpCodes::OP_11)),
"12" => return Ok(ScriptBit::OpCode(OpCodes::OP_12)),
"13" => return Ok(ScriptBit::OpCode(OpCodes::OP_13)),
"14" => return Ok(ScriptBit::OpCode(OpCodes::OP_14)),
"15" => return Ok(ScriptBit::OpCode(OpCodes::OP_15)),
"16" => return Ok(ScriptBit::OpCode(OpCodes::OP_16)),
_ => (),
}
if let Ok(opcode) = OpCodes::from_str(code) {
return Ok(ScriptBit::OpCode(opcode));
}
let data_bytes = hex::decode(code)?;
let bit = match VarInt::get_pushdata_opcode(data_bytes.len() as u64) {
Some(v) => ScriptBit::PushData(v, data_bytes),
None => ScriptBit::Push(data_bytes),
};
Ok(bit)
}
pub(crate) fn from_asm_string_impl(asm: &str) -> Result<Script, BSVErrors> {
let bits: Result<Vec<_>, _> = asm.split(' ').map(Script::map_string_to_script_bit).collect();
Ok(Script(bits?))
}
pub(crate) fn get_pushdata_prefix_bytes_impl(length: usize) -> Result<Vec<u8>, BSVErrors> {
match length {
op_push @ 0x01..=0x4b => Ok(vec![op_push as u8]),
op_pushdata1_size @ 0x4c..=0xFF => {
let op_pushdata1_byte = OpCodes::OP_PUSHDATA1
.to_u8()
.ok_or_else(|| BSVErrors::DeserialiseScript("Unable to deserialise OP_PUSHDATA1 Code to u8".into()))?;
Ok(vec![op_pushdata1_byte, op_pushdata1_size as u8])
}
op_pushdata2_size @ 0x100..=0xFFFF => {
let op_pushdata2_byte = OpCodes::OP_PUSHDATA2
.to_u8()
.ok_or_else(|| BSVErrors::DeserialiseScript("Unable to deserialise OP_PUSHDATA2 Code to u8".into()))?;
let mut push_data_prefix = vec![op_pushdata2_byte];
push_data_prefix.write_u16::<LittleEndian>(op_pushdata2_size as u16)?;
Ok(push_data_prefix)
}
op_pushdata4_size if op_pushdata4_size > 0x10000 && op_pushdata4_size <= 0xFFFFFFFF => {
let op_pushdata4_byte = OpCodes::OP_PUSHDATA4
.to_u8()
.ok_or_else(|| BSVErrors::DeserialiseScript("Unable to deserialise OP_PUSHDATA4 Code to u8".into()))?;
let mut push_data_prefix = vec![op_pushdata4_byte];
push_data_prefix.write_u32::<LittleEndian>(op_pushdata4_size as u32)?;
Ok(push_data_prefix)
}
size => return Err(BSVErrors::DeserialiseScript(format!("{} is too large for OP_PUSHDATAX commands", size))),
}
}
pub(crate) fn encode_pushdata_impl(data_bytes: &[u8]) -> Result<Vec<u8>, BSVErrors> {
let mut pushdata_bytes = Script::get_pushdata_prefix_bytes_impl(data_bytes.len())?;
pushdata_bytes.append(&mut data_bytes.to_vec());
Ok(pushdata_bytes)
}
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
impl Script {
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = toBytes))]
pub fn to_bytes(&self) -> Vec<u8> {
let bytes = self
.0
.iter()
.map(|x| match x {
ScriptBit::OpCode(code) => vec![*code as u8],
ScriptBit::Push(bytes) => {
let mut pushbytes = bytes.clone();
pushbytes.insert(0, bytes.len() as u8);
pushbytes
}
ScriptBit::PushData(code, bytes) => {
let mut pushbytes = vec![*code as u8];
let length_bytes = match code {
OpCodes::OP_PUSHDATA1 => (bytes.len() as u8).to_le_bytes().to_vec(),
OpCodes::OP_PUSHDATA2 => (bytes.len() as u16).to_le_bytes().to_vec(),
_ => (bytes.len() as u32).to_le_bytes().to_vec(),
};
pushbytes.extend(length_bytes);
pushbytes.extend(bytes);
pushbytes
}
})
.flatten()
.collect();
bytes
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = getScriptLength))]
pub fn get_script_length(&self) -> usize {
self.to_bytes().len()
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = toHex))]
pub fn to_hex(&self) -> String {
hex::encode(self.to_bytes())
}
pub fn remove_codeseparators(&mut self) {
self.0 = self.0.clone().into_iter().filter(|x| *x != ScriptBit::OpCode(OpCodes::OP_CODESEPARATOR)).collect();
}
}
impl Script {
pub fn from_chunks(chunks: Vec<Vec<u8>>) -> Result<Script, BSVErrors> {
Script::from_bytes_impl(&chunks.into_iter().flatten().collect::<Vec<u8>>())
}
}
#[cfg(not(target_arch = "wasm32"))]
impl Script {
pub fn to_asm_string(&self) -> String {
Script::to_asm_string_impl(self, false)
}
pub fn from_bytes(bytes: &[u8]) -> Result<Script, BSVErrors> {
Script::from_bytes_impl(bytes)
}
pub fn to_extended_asm_string(&self) -> String {
Script::to_asm_string_impl(self, true)
}
pub fn from_hex(hex: &str) -> Result<Script, BSVErrors> {
Script::from_hex_impl(hex)
}
pub fn from_asm_string(asm_string: &str) -> Result<Script, BSVErrors> {
Script::from_asm_string_impl(asm_string)
}
pub fn encode_pushdata(data_bytes: &[u8]) -> Result<Vec<u8>, BSVErrors> {
Script::encode_pushdata_impl(data_bytes)
}
pub fn get_pushdata_bytes(length: usize) -> Result<Vec<u8>, BSVErrors> {
Script::get_pushdata_prefix_bytes_impl(length)
}
}
#[cfg(target_arch = "wasm32")]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
impl Script {
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = toASMString))]
pub fn to_asm_string(&self) -> String {
Script::to_asm_string_impl(&self, false)
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = toExtendedASMString))]
pub fn to_extended_asm_string(&self) -> String {
Script::to_asm_string_impl(&self, true)
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = fromHex))]
pub fn from_hex(hex: &str) -> Result<Script, JsValue> {
match Script::from_hex_impl(hex) {
Ok(v) => Ok(v),
Err(e) => throw_str(&e.to_string()),
}
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = fromBytes))]
pub fn from_bytes(bytes: &[u8]) -> Result<Script, JsValue> {
match Script::from_bytes_impl(bytes) {
Ok(v) => Ok(v),
Err(e) => throw_str(&e.to_string()),
}
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = fromASMString))]
pub fn from_asm_string(asm_string: &str) -> Result<Script, JsValue> {
match Script::from_asm_string_impl(asm_string) {
Ok(v) => Ok(v),
Err(e) => throw_str(&e.to_string()),
}
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = encodePushData))]
pub fn encode_pushdata(data_bytes: &[u8]) -> Result<Vec<u8>, JsValue> {
match Script::encode_pushdata_impl(data_bytes) {
Ok(v) => Ok(v),
Err(e) => throw_str(&e.to_string()),
}
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen(js_name = getPushDataBytes))]
pub fn get_pushdata_bytes(length: usize) -> Result<Vec<u8>, JsValue> {
match Script::get_pushdata_prefix_bytes_impl(length) {
Ok(v) => Ok(v),
Err(e) => throw_str(&e.to_string()),
}
}
}