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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
use std::{fmt, str::FromStr};
use bitcoin::{self, blockdata::script, Script};
use expression::{self, FromTree};
use miniscript::context::ScriptContext;
use policy::{semantic, Liftable};
use push_opcode_size;
use util::{varint_len, witness_to_scriptsig};
use {
Error, ForEach, ForEachKey, Legacy, Miniscript, MiniscriptKey, Satisfier, Segwitv0,
ToPublicKey, TranslatePk,
};
use super::{
checksum::{desc_checksum, verify_checksum},
DescriptorTrait, SortedMultiVec, Wpkh, Wsh,
};
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub struct Sh<Pk: MiniscriptKey> {
inner: ShInner<Pk>,
}
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub enum ShInner<Pk: MiniscriptKey> {
Wsh(Wsh<Pk>),
Wpkh(Wpkh<Pk>),
SortedMulti(SortedMultiVec<Pk, Legacy>),
Ms(Miniscript<Pk, Legacy>),
}
impl<Pk: MiniscriptKey> Liftable<Pk> for Sh<Pk> {
fn lift(&self) -> Result<semantic::Policy<Pk>, Error> {
match self.inner {
ShInner::Wsh(ref wsh) => wsh.lift(),
ShInner::Wpkh(ref pk) => Ok(semantic::Policy::KeyHash(pk.as_inner().to_pubkeyhash())),
ShInner::SortedMulti(ref smv) => smv.lift(),
ShInner::Ms(ref ms) => ms.lift(),
}
}
}
impl<Pk: MiniscriptKey> fmt::Debug for Sh<Pk> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.inner {
ShInner::Wsh(ref wsh_inner) => write!(f, "sh({:?})", wsh_inner),
ShInner::Wpkh(ref pk) => write!(f, "sh({:?})", pk),
ShInner::SortedMulti(ref smv) => write!(f, "sh({:?})", smv),
ShInner::Ms(ref ms) => write!(f, "sh({:?})", ms),
}
}
}
impl<Pk: MiniscriptKey> fmt::Display for Sh<Pk> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let desc = match self.inner {
ShInner::Wsh(ref wsh) => format!("sh({})", wsh.to_string_no_checksum()),
ShInner::Wpkh(ref pk) => format!("sh({})", pk.to_string_no_checksum()),
ShInner::SortedMulti(ref smv) => format!("sh({})", smv),
ShInner::Ms(ref ms) => format!("sh({})", ms),
};
let checksum = desc_checksum(&desc).map_err(|_| fmt::Error)?;
write!(f, "{}#{}", &desc, &checksum)
}
}
impl<Pk> FromTree for Sh<Pk>
where
Pk: MiniscriptKey + FromStr,
Pk::Hash: FromStr,
<Pk as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString,
{
fn from_tree(top: &expression::Tree) -> Result<Self, Error> {
if top.name == "sh" && top.args.len() == 1 {
let top = &top.args[0];
let inner = match top.name {
"wsh" => ShInner::Wsh(Wsh::from_tree(&top)?),
"wpkh" => ShInner::Wpkh(Wpkh::from_tree(&top)?),
"sortedmulti" => ShInner::SortedMulti(SortedMultiVec::from_tree(&top)?),
_ => {
let sub = Miniscript::from_tree(&top)?;
Legacy::top_level_checks(&sub)?;
ShInner::Ms(sub)
}
};
Ok(Sh { inner: inner })
} else {
Err(Error::Unexpected(format!(
"{}({} args) while parsing sh descriptor",
top.name,
top.args.len(),
)))
}
}
}
impl<Pk> FromStr for Sh<Pk>
where
Pk: MiniscriptKey + FromStr,
Pk::Hash: FromStr,
<Pk as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString,
{
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let desc_str = verify_checksum(s)?;
let top = expression::Tree::from_str(desc_str)?;
Self::from_tree(&top)
}
}
impl<Pk: MiniscriptKey> Sh<Pk> {
pub fn into_inner(self) -> ShInner<Pk> {
self.inner
}
pub fn as_inner(&self) -> &ShInner<Pk> {
&self.inner
}
pub fn new(ms: Miniscript<Pk, Legacy>) -> Result<Self, Error> {
Legacy::top_level_checks(&ms)?;
Ok(Self {
inner: ShInner::Ms(ms),
})
}
pub fn new_sortedmulti(k: usize, pks: Vec<Pk>) -> Result<Self, Error> {
Ok(Self {
inner: ShInner::SortedMulti(SortedMultiVec::new(k, pks)?),
})
}
pub fn new_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Self, Error> {
Ok(Self {
inner: ShInner::Wsh(Wsh::new(ms)?),
})
}
pub fn new_wsh_sortedmulti(k: usize, pks: Vec<Pk>) -> Result<Self, Error> {
Ok(Self {
inner: ShInner::Wsh(Wsh::new_sortedmulti(k, pks)?),
})
}
pub fn new_wpkh(pk: Pk) -> Result<Self, Error> {
Ok(Self {
inner: ShInner::Wpkh(Wpkh::new(pk)?),
})
}
}
impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Sh<Pk> {
fn sanity_check(&self) -> Result<(), Error> {
match self.inner {
ShInner::Wsh(ref wsh) => wsh.sanity_check()?,
ShInner::Wpkh(ref wpkh) => wpkh.sanity_check()?,
ShInner::SortedMulti(ref smv) => smv.sanity_check()?,
ShInner::Ms(ref ms) => ms.sanity_check()?,
}
Ok(())
}
fn address(&self, network: bitcoin::Network) -> Result<bitcoin::Address, Error>
where
Pk: ToPublicKey,
{
match self.inner {
ShInner::Wsh(ref wsh) => Ok(bitcoin::Address::p2sh(&wsh.script_pubkey(), network)),
ShInner::Wpkh(ref wpkh) => Ok(bitcoin::Address::p2sh(&wpkh.script_pubkey(), network)),
ShInner::SortedMulti(ref smv) => Ok(bitcoin::Address::p2sh(&smv.encode(), network)),
ShInner::Ms(ref ms) => Ok(bitcoin::Address::p2sh(&ms.encode(), network)),
}
}
fn script_pubkey(&self) -> Script
where
Pk: ToPublicKey,
{
match self.inner {
ShInner::Wsh(ref wsh) => wsh.script_pubkey().to_p2sh(),
ShInner::Wpkh(ref wpkh) => wpkh.script_pubkey().to_p2sh(),
ShInner::SortedMulti(ref smv) => smv.encode().to_p2sh(),
ShInner::Ms(ref ms) => ms.encode().to_p2sh(),
}
}
fn unsigned_script_sig(&self) -> Script
where
Pk: ToPublicKey,
{
match self.inner {
ShInner::Wsh(ref wsh) => {
let witness_script = wsh.explicit_script();
script::Builder::new()
.push_slice(&witness_script.to_v0_p2wsh()[..])
.into_script()
}
ShInner::Wpkh(ref wpkh) => {
let redeem_script = wpkh.script_pubkey();
script::Builder::new()
.push_slice(&redeem_script[..])
.into_script()
}
ShInner::SortedMulti(..) | ShInner::Ms(..) => Script::new(),
}
}
fn explicit_script(&self) -> Script
where
Pk: ToPublicKey,
{
match self.inner {
ShInner::Wsh(ref wsh) => wsh.explicit_script(),
ShInner::Wpkh(ref wpkh) => wpkh.script_pubkey(),
ShInner::SortedMulti(ref smv) => smv.encode(),
ShInner::Ms(ref ms) => ms.encode(),
}
}
fn get_satisfaction<S>(&self, satisfier: S) -> Result<(Vec<Vec<u8>>, Script), Error>
where
Pk: ToPublicKey,
S: Satisfier<Pk>,
{
let script_sig = self.unsigned_script_sig();
match self.inner {
ShInner::Wsh(ref wsh) => {
let (witness, _) = wsh.get_satisfaction(satisfier)?;
Ok((witness, script_sig))
}
ShInner::Wpkh(ref wpkh) => {
let (witness, _) = wpkh.get_satisfaction(satisfier)?;
Ok((witness, script_sig))
}
ShInner::SortedMulti(ref smv) => {
let mut script_witness = smv.satisfy(satisfier)?;
script_witness.push(smv.encode().into_bytes());
let script_sig = witness_to_scriptsig(&script_witness);
let witness = vec![];
Ok((witness, script_sig))
}
ShInner::Ms(ref ms) => {
let mut script_witness = ms.satisfy(satisfier)?;
script_witness.push(ms.encode().into_bytes());
let script_sig = witness_to_scriptsig(&script_witness);
let witness = vec![];
Ok((witness, script_sig))
}
}
}
fn max_satisfaction_weight(&self) -> Result<usize, Error> {
Ok(match self.inner {
ShInner::Wsh(ref wsh) => 4 * 35 + wsh.max_satisfaction_weight()?,
ShInner::SortedMulti(ref smv) => {
let ss = smv.script_size();
let ps = push_opcode_size(ss);
let scriptsig_len = ps + ss + smv.max_satisfaction_size();
4 * (varint_len(scriptsig_len) + scriptsig_len)
}
ShInner::Wpkh(ref wpkh) => 4 * 23 + wpkh.max_satisfaction_weight()?,
ShInner::Ms(ref ms) => {
let ss = ms.script_size();
let ps = push_opcode_size(ss);
let scriptsig_len = ps + ss + ms.max_satisfaction_size()?;
4 * (varint_len(scriptsig_len) + scriptsig_len)
}
})
}
fn script_code(&self) -> Script
where
Pk: ToPublicKey,
{
match self.inner {
ShInner::Wsh(ref wsh) => wsh.script_code(),
ShInner::SortedMulti(ref smv) => smv.encode(),
ShInner::Wpkh(ref wpkh) => wpkh.script_code(),
ShInner::Ms(ref ms) => ms.encode(),
}
}
}
impl<Pk: MiniscriptKey> ForEachKey<Pk> for Sh<Pk> {
fn for_each_key<'a, F: FnMut(ForEach<'a, Pk>) -> bool>(&'a self, pred: F) -> bool
where
Pk: 'a,
Pk::Hash: 'a,
{
match self.inner {
ShInner::Wsh(ref wsh) => wsh.for_each_key(pred),
ShInner::SortedMulti(ref smv) => smv.for_each_key(pred),
ShInner::Wpkh(ref wpkh) => wpkh.for_each_key(pred),
ShInner::Ms(ref ms) => ms.for_each_key(pred),
}
}
}
impl<P: MiniscriptKey, Q: MiniscriptKey> TranslatePk<P, Q> for Sh<P> {
type Output = Sh<Q>;
fn translate_pk<Fpk, Fpkh, E>(
&self,
mut translatefpk: Fpk,
mut translatefpkh: Fpkh,
) -> Result<Self::Output, E>
where
Fpk: FnMut(&P) -> Result<Q, E>,
Fpkh: FnMut(&P::Hash) -> Result<Q::Hash, E>,
Q: MiniscriptKey,
{
let inner = match self.inner {
ShInner::Wsh(ref wsh) => {
ShInner::Wsh(wsh.translate_pk(&mut translatefpk, &mut translatefpkh)?)
}
ShInner::Wpkh(ref wpkh) => {
ShInner::Wpkh(wpkh.translate_pk(&mut translatefpk, &mut translatefpkh)?)
}
ShInner::SortedMulti(ref smv) => {
ShInner::SortedMulti(smv.translate_pk(&mut translatefpk)?)
}
ShInner::Ms(ref ms) => {
ShInner::Ms(ms.translate_pk(&mut translatefpk, &mut translatefpkh)?)
}
};
Ok(Sh { inner: inner })
}
}