-
Notifications
You must be signed in to change notification settings - Fork 131
/
lib.rs
866 lines (779 loc) · 28.6 KB
/
lib.rs
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
// Miniscript
// Written in 2019 by
// Andrew Poelstra <apoelstra@wpsoftware.net>
//
// 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/>.
//
//! Miniscript and Output Descriptors
//!
//! # Introduction
//! ## Bitcoin Script
//!
//! In Bitcoin, spending policies are defined and enforced by means of a
//! stack-based programming language known as Bitcoin Script. While this
//! language appears to be designed with tractable analysis in mind (e.g.
//! there are no looping or jumping constructions), in practice this is
//! extremely difficult. As a result, typical wallet software supports only
//! a small set of script templates, cannot interoperate with other similar
//! software, and each wallet contains independently written ad-hoc manually
//! verified code to handle these templates. Users who require more complex
//! spending policies, or who want to combine signing infrastructure which
//! was not explicitly designed to work together, are simply out of luck.
//!
//! ## Miniscript
//!
//! Miniscript is an alternative to Bitcoin Script which eliminates these
//! problems. It can be efficiently and simply encoded as Script to ensure
//! that it works on the Bitcoin blockchain, but its design is very different.
//! Essentially, a Miniscript is a monotone function (tree of ANDs, ORs and
//! thresholds) of signature requirements, hash preimage requirements, and
//! timelocks.
//!
//! A [full description of Miniscript is available here](http://bitcoin.sipa.be/miniscript/miniscript.html).
//!
//! Miniscript also admits a more human-readable encoding.
//!
//! ## Output Descriptors
//!
//! While spending policies in Bitcoin are entirely defined by Script; there
//! are multiple ways of embedding these Scripts in transaction outputs; for
//! example, P2SH or Segwit v0. These different embeddings are expressed by
//! *Output Descriptors*, [which are described here](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md)
//!
//! # Examples
//!
//! ## Deriving an address from a descriptor
//!
//! ```rust
//! use std::str::FromStr;
//!
//! let desc = miniscript::Descriptor::<bitcoin::PublicKey>::from_str("\
//! sh(wsh(or_d(\
//! c:pk_k(020e0338c96a8870479f2396c373cc7696ba124e8635d41b0ea581112b67817261),\
//! c:pk_k(0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352)\
//! )))\
//! ").unwrap();
//!
//! // Derive the P2SH address
//! assert_eq!(
//! desc.address(bitcoin::Network::Bitcoin).unwrap().to_string(),
//! "3CJxbQBfWAe1ZkKiGQNEYrioV73ZwvBWns"
//! );
//!
//! // Check whether the descriptor is safe. This checks whether all spend paths are accessible in
//! // the Bitcoin network. It may be possible that some of the spend paths require more than 100
//! // elements in Wsh scripts or they contain a combination of timelock and heightlock.
//! assert!(desc.sanity_check().is_ok());
//!
//! // Estimate the satisfaction cost
//! assert_eq!(desc.max_satisfaction_weight().unwrap(), 293);
//! ```
//!
#![cfg_attr(all(test, feature = "unstable"), feature(test))]
// Coding conventions
#![deny(unsafe_code)]
#![deny(non_upper_case_globals)]
#![deny(non_camel_case_types)]
#![deny(non_snake_case)]
#![deny(unused_mut)]
#![deny(dead_code)]
#![deny(unused_imports)]
#![deny(missing_docs)]
pub use bitcoin;
#[cfg(feature = "serde")]
pub use serde;
#[cfg(all(test, feature = "unstable"))]
extern crate test;
#[macro_use]
mod macros;
pub mod descriptor;
pub mod expression;
pub mod interpreter;
pub mod miniscript;
pub mod policy;
pub mod psbt;
mod util;
use std::str::FromStr;
use std::{error, fmt, hash, str};
use bitcoin::blockdata::{opcodes, script};
use bitcoin::hashes::{hash160, sha256, Hash};
pub use crate::descriptor::{Descriptor, DescriptorPublicKey};
pub use crate::interpreter::Interpreter;
pub use crate::miniscript::context::{BareCtx, Legacy, ScriptContext, Segwitv0, Tap};
pub use crate::miniscript::decode::Terminal;
pub use crate::miniscript::satisfy::{Preimage32, Satisfier};
pub use crate::miniscript::Miniscript;
///Public key trait which can be converted to Hash type
pub trait MiniscriptKey: Clone + Eq + Ord + fmt::Debug + fmt::Display + hash::Hash {
/// Returns true if the pubkey is uncompressed. Defaults to `false`.
fn is_uncompressed(&self) -> bool {
false
}
/// Returns true if the pubkey is an x-only pubkey. Defaults to `false`.
// This is required to know what in DescriptorPublicKey to know whether the inner
// key in allowed in descriptor context
fn is_x_only_key(&self) -> bool {
false
}
/// The associated [`Hash`] type for this pubkey.
type Hash: Clone + Eq + Ord + fmt::Display + fmt::Debug + hash::Hash;
/// Converts this key to the associated pubkey hash.
fn to_pubkeyhash(&self) -> Self::Hash;
}
impl MiniscriptKey for bitcoin::secp256k1::PublicKey {
type Hash = hash160::Hash;
fn to_pubkeyhash(&self) -> Self::Hash {
hash160::Hash::hash(&self.serialize())
}
}
impl MiniscriptKey for bitcoin::PublicKey {
/// Returns the compressed-ness of the underlying secp256k1 key.
fn is_uncompressed(&self) -> bool {
!self.compressed
}
type Hash = hash160::Hash;
fn to_pubkeyhash(&self) -> Self::Hash {
hash160::Hash::hash(&self.to_bytes())
}
}
impl MiniscriptKey for bitcoin::secp256k1::XOnlyPublicKey {
type Hash = hash160::Hash;
fn to_pubkeyhash(&self) -> Self::Hash {
hash160::Hash::hash(&self.serialize())
}
fn is_x_only_key(&self) -> bool {
true
}
}
impl MiniscriptKey for String {
type Hash = String;
fn to_pubkeyhash(&self) -> Self::Hash {
(&self).to_string()
}
}
/// Trait describing public key types which can be converted to bitcoin pubkeys
pub trait ToPublicKey: MiniscriptKey {
/// Converts an object to a public key
fn to_public_key(&self) -> bitcoin::PublicKey;
/// Convert an object to x-only pubkey
fn to_x_only_pubkey(&self) -> bitcoin::secp256k1::XOnlyPublicKey {
let pk = self.to_public_key();
bitcoin::secp256k1::XOnlyPublicKey::from(pk.inner)
}
/// Converts a hashed version of the public key to a `hash160` hash.
///
/// This method must be consistent with `to_public_key`, in the sense
/// that calling `MiniscriptKey::to_pubkeyhash` followed by this function
/// should give the same result as calling `to_public_key` and hashing
/// the result directly.
fn hash_to_hash160(hash: &<Self as MiniscriptKey>::Hash) -> hash160::Hash;
}
impl ToPublicKey for bitcoin::PublicKey {
fn to_public_key(&self) -> bitcoin::PublicKey {
*self
}
fn hash_to_hash160(hash: &hash160::Hash) -> hash160::Hash {
*hash
}
}
impl ToPublicKey for bitcoin::secp256k1::PublicKey {
fn to_public_key(&self) -> bitcoin::PublicKey {
bitcoin::PublicKey::new(*self)
}
fn hash_to_hash160(hash: &hash160::Hash) -> hash160::Hash {
*hash
}
}
impl ToPublicKey for bitcoin::secp256k1::XOnlyPublicKey {
fn to_public_key(&self) -> bitcoin::PublicKey {
// This code should never be used.
// But is implemented for completeness
let mut data: Vec<u8> = vec![0x02];
data.extend(self.serialize().iter());
bitcoin::PublicKey::from_slice(&data)
.expect("Failed to construct 33 Publickey from 0x02 appended x-only key")
}
fn to_x_only_pubkey(&self) -> bitcoin::secp256k1::XOnlyPublicKey {
*self
}
fn hash_to_hash160(hash: &hash160::Hash) -> hash160::Hash {
*hash
}
}
/// Dummy key which de/serializes to the empty string; useful sometimes for testing
#[derive(Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Debug)]
pub struct DummyKey;
impl str::FromStr for DummyKey {
type Err = &'static str;
fn from_str(x: &str) -> Result<DummyKey, &'static str> {
if x.is_empty() {
Ok(DummyKey)
} else {
Err("non empty dummy key")
}
}
}
impl MiniscriptKey for DummyKey {
type Hash = DummyKeyHash;
fn to_pubkeyhash(&self) -> Self::Hash {
DummyKeyHash
}
}
impl hash::Hash for DummyKey {
fn hash<H: hash::Hasher>(&self, state: &mut H) {
"DummyKey".hash(state);
}
}
impl fmt::Display for DummyKey {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("")
}
}
impl ToPublicKey for DummyKey {
fn to_public_key(&self) -> bitcoin::PublicKey {
bitcoin::PublicKey::from_str(
"0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352",
)
.unwrap()
}
fn hash_to_hash160(_: &DummyKeyHash) -> hash160::Hash {
hash160::Hash::from_str("f54a5851e9372b87810a8e60cdd2e7cfd80b6e31").unwrap()
}
}
/// Dummy keyhash which de/serializes to the empty string; useful sometimes for testing
#[derive(Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Debug)]
pub struct DummyKeyHash;
impl str::FromStr for DummyKeyHash {
type Err = &'static str;
fn from_str(x: &str) -> Result<DummyKeyHash, &'static str> {
if x.is_empty() {
Ok(DummyKeyHash)
} else {
Err("non empty dummy key")
}
}
}
impl fmt::Display for DummyKeyHash {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("")
}
}
impl hash::Hash for DummyKeyHash {
fn hash<H: hash::Hasher>(&self, state: &mut H) {
"DummyKeyHash".hash(state);
}
}
/// Converts a descriptor using abstract keys to one using specific keys.
///
/// # Panics
///
/// If `fpk` returns an uncompressed key when converting to a segwit descriptor.
/// To prevent this panic, ensure `fpk` returns an error in this case instead.
pub trait TranslatePk<P, Q>
where
P: MiniscriptKey,
Q: MiniscriptKey,
{
/// The associated output type. This must be `Self<Q>`.
type Output;
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`, and translation for PkH is
/// provided by function `fpkh`.
fn translate_pk<Fpk, Fpkh, E>(&self, fpk: Fpk, fpkh: Fpkh) -> Result<Self::Output, E>
where
Fpk: FnMut(&P) -> Result<Q, E>,
Fpkh: FnMut(&P::Hash) -> Result<Q::Hash, E>;
/// Calls `Self::translate_pk` with conversion functions that cannot fail.
fn translate_pk_infallible<Fpk, Fpkh>(&self, mut fpk: Fpk, mut fpkh: Fpkh) -> Self::Output
where
Fpk: FnMut(&P) -> Q,
Fpkh: FnMut(&P::Hash) -> Q::Hash,
{
self.translate_pk::<_, _, ()>(|pk| Ok(fpk(pk)), |pkh| Ok(fpkh(pkh)))
.expect("infallible translation function")
}
}
/// Variant of `TranslatePk` where P and Q both have the same hash
/// type, and the hashes can be converted by just cloning them.
pub trait TranslatePk1<P, Q>: TranslatePk<P, Q>
where
P: MiniscriptKey,
Q: MiniscriptKey<Hash = P::Hash>,
{
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk1<Fpk, E>(&self, fpk: Fpk) -> Result<<Self as TranslatePk<P, Q>>::Output, E>
where
Fpk: FnMut(&P) -> Result<Q, E>,
{
self.translate_pk(fpk, |h| Ok(h.clone()))
}
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk1_infallible<Fpk>(&self, fpk: Fpk) -> <Self as TranslatePk<P, Q>>::Output
where
Fpk: FnMut(&P) -> Q,
{
self.translate_pk_infallible(fpk, P::Hash::clone)
}
}
impl<P, Q, T> TranslatePk1<P, Q> for T
where
P: MiniscriptKey,
Q: MiniscriptKey<Hash = P::Hash>,
T: TranslatePk<P, Q>,
{
}
/// Variant of `TranslatePk` where P's hash is P, so the hashes
/// can be converted by reusing the key-conversion function.
pub trait TranslatePk2<P, Q>: TranslatePk<P, Q>
where
P: MiniscriptKey<Hash = P>,
Q: MiniscriptKey,
{
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk2<Fpk, E>(&self, fpk: Fpk) -> Result<<Self as TranslatePk<P, Q>>::Output, E>
where
Fpk: Fn(&P) -> Result<Q, E>,
{
self.translate_pk(&fpk, |h| fpk(h).map(|q| q.to_pubkeyhash()))
}
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk2_infallible<Fpk>(&self, fpk: Fpk) -> <Self as TranslatePk<P, Q>>::Output
where
Fpk: Fn(&P) -> Q,
{
self.translate_pk_infallible(&fpk, |h| fpk(h).to_pubkeyhash())
}
}
impl<P, Q, T> TranslatePk2<P, Q> for T
where
P: MiniscriptKey<Hash = P>,
Q: MiniscriptKey,
T: TranslatePk<P, Q>,
{
}
/// Variant of `TranslatePk` where Q's hash is `hash160` so we can
/// derive hashes by calling `hash_to_hash160`.
pub trait TranslatePk3<P: MiniscriptKey + ToPublicKey, Q: MiniscriptKey<Hash = hash160::Hash>>:
TranslatePk<P, Q>
{
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk3<Fpk, E>(&self, fpk: Fpk) -> Result<<Self as TranslatePk<P, Q>>::Output, E>
where
Fpk: FnMut(&P) -> Result<Q, E>,
{
self.translate_pk(fpk, |h| Ok(P::hash_to_hash160(h)))
}
/// Translates a struct from one generic to another where the translation
/// for Pk is provided by function `fpk`.
fn translate_pk3_infallible<Fpk>(&self, fpk: Fpk) -> <Self as TranslatePk<P, Q>>::Output
where
Fpk: FnMut(&P) -> Q,
{
self.translate_pk_infallible(fpk, P::hash_to_hash160)
}
}
impl<P, Q, T> TranslatePk3<P, Q> for T
where
P: MiniscriptKey + ToPublicKey,
Q: MiniscriptKey<Hash = hash160::Hash>,
T: TranslatePk<P, Q>,
{
}
/// Either a key or a keyhash
pub enum ForEach<'a, Pk: MiniscriptKey> {
/// A key
Key(&'a Pk),
/// A keyhash
Hash(&'a Pk::Hash),
}
impl<'a, Pk: MiniscriptKey<Hash = Pk>> ForEach<'a, Pk> {
/// Convenience method to avoid distinguishing between keys and hashes when these are the same type
pub fn as_key(&self) -> &'a Pk {
match *self {
ForEach::Key(ref_key) => ref_key,
ForEach::Hash(ref_key) => ref_key,
}
}
}
/// Trait describing the ability to iterate over every key
pub trait ForEachKey<Pk: MiniscriptKey> {
/// Run a predicate on every key in the descriptor, returning whether
/// the predicate returned true for every key
fn for_each_key<'a, F: FnMut(ForEach<'a, Pk>) -> bool>(&'a self, pred: F) -> bool
where
Pk: 'a,
Pk::Hash: 'a;
/// Run a predicate on every key in the descriptor, returning whether
/// the predicate returned true for any key
fn for_any_key<'a, F: FnMut(ForEach<'a, Pk>) -> bool>(&'a self, mut pred: F) -> bool
where
Pk: 'a,
Pk::Hash: 'a,
{
!self.for_each_key(|key| !pred(key))
}
}
/// Miniscript
#[derive(Debug, PartialEq)]
pub enum Error {
/// Opcode appeared which is not part of the script subset
InvalidOpcode(opcodes::All),
/// Some opcode occurred followed by `OP_VERIFY` when it had
/// a `VERIFY` version that should have been used instead
NonMinimalVerify(String),
/// Push was illegal in some context
InvalidPush(Vec<u8>),
/// rust-bitcoin script error
Script(script::Error),
/// rust-bitcoin address error
AddrError(bitcoin::util::address::Error),
/// A `CHECKMULTISIG` opcode was preceded by a number > 20
CmsTooManyKeys(u32),
/// A tapscript multi_a cannot support more than MAX_BLOCK_WEIGHT/32 keys
MultiATooManyKeys(u32),
/// Encountered unprintable character in descriptor
Unprintable(u8),
/// expected character while parsing descriptor; didn't find one
ExpectedChar(char),
/// While parsing backward, hit beginning of script
UnexpectedStart,
/// Got something we were not expecting
Unexpected(String),
/// Name of a fragment contained `:` multiple times
MultiColon(String),
/// Name of a fragment contained `@` multiple times
MultiAt(String),
/// Name of a fragment contained `@` but we were not parsing an OR
AtOutsideOr(String),
/// Encountered a `l:0` which is syntactically equal to `u:0` except stupid
LikelyFalse,
/// Encountered a wrapping character that we don't recognize
UnknownWrapper(char),
/// Parsed a miniscript and the result was not of type T
NonTopLevel(String),
/// Parsed a miniscript but there were more script opcodes after it
Trailing(String),
/// Failed to parse a push as a public key
BadPubkey(bitcoin::util::key::Error),
/// Could not satisfy a script (fragment) because of a missing hash preimage
MissingHash(sha256::Hash),
/// Could not satisfy a script (fragment) because of a missing signature
MissingSig(bitcoin::PublicKey),
/// Could not satisfy, relative locktime not met
RelativeLocktimeNotMet(u32),
/// Could not satisfy, absolute locktime not met
AbsoluteLocktimeNotMet(u32),
/// General failure to satisfy
CouldNotSatisfy,
/// Typechecking failed
TypeCheck(String),
/// General error in creating descriptor
BadDescriptor(String),
/// Forward-secp related errors
Secp(bitcoin::secp256k1::Error),
#[cfg(feature = "compiler")]
/// Compiler related errors
CompilerError(crate::policy::compiler::CompilerError),
/// Errors related to policy
PolicyError(policy::concrete::PolicyError),
/// Errors related to lifting
LiftError(policy::LiftError),
/// Forward script context related errors
ContextError(miniscript::context::ScriptContextError),
/// Recursion depth exceeded when parsing policy/miniscript from string
MaxRecursiveDepthExceeded,
/// Script size too large
ScriptSizeTooLarge,
/// Anything but c:pk(key) (P2PK), c:pk_h(key) (P2PKH), and thresh_m(k,...)
/// up to n=3 is invalid by standardness (bare)
NonStandardBareScript,
/// Analysis Error
AnalysisError(miniscript::analyzable::AnalysisError),
/// Miniscript is equivalent to false. No possible satisfaction
ImpossibleSatisfaction,
/// Bare descriptors don't have any addresses
BareDescriptorAddr,
/// PubKey invalid under current context
PubKeyCtxError(miniscript::decode::KeyParseError, &'static str),
/// Attempted to call function that requires PreComputed taproot info
TaprootSpendInfoUnavialable,
/// No script code for Tr descriptors
TrNoScriptCode,
/// No explicit script for Tr descriptors
TrNoExplicitScript,
}
// https://github.com/sipa/miniscript/pull/5 for discussion on this number
const MAX_RECURSION_DEPTH: u32 = 402;
// https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki
const MAX_SCRIPT_SIZE: u32 = 10000;
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
Error::InvalidOpcode(op) => write!(f, "invalid opcode {}", op),
Error::NonMinimalVerify(ref tok) => write!(f, "{} VERIFY", tok),
Error::InvalidPush(ref push) => write!(f, "invalid push {:?}", push), // TODO hexify this
Error::Script(ref e) => fmt::Display::fmt(e, f),
Error::AddrError(ref e) => fmt::Display::fmt(e, f),
Error::CmsTooManyKeys(n) => write!(f, "checkmultisig with {} keys", n),
Error::Unprintable(x) => write!(f, "unprintable character 0x{:02x}", x),
Error::ExpectedChar(c) => write!(f, "expected {}", c),
Error::UnexpectedStart => f.write_str("unexpected start of script"),
Error::Unexpected(ref s) => write!(f, "unexpected «{}»", s),
Error::MultiColon(ref s) => write!(f, "«{}» has multiple instances of «:»", s),
Error::MultiAt(ref s) => write!(f, "«{}» has multiple instances of «@»", s),
Error::AtOutsideOr(ref s) => write!(f, "«{}» contains «@» in non-or() context", s),
Error::LikelyFalse => write!(f, "0 is not very likely (use «u:0»)"),
Error::UnknownWrapper(ch) => write!(f, "unknown wrapper «{}:»", ch),
Error::NonTopLevel(ref s) => write!(f, "non-T miniscript: {}", s),
Error::Trailing(ref s) => write!(f, "trailing tokens: {}", s),
Error::MissingHash(ref h) => write!(f, "missing preimage of hash {}", h),
Error::MissingSig(ref pk) => write!(f, "missing signature for key {:?}", pk),
Error::RelativeLocktimeNotMet(n) => {
write!(f, "required relative locktime CSV of {} blocks, not met", n)
}
Error::AbsoluteLocktimeNotMet(n) => write!(
f,
"required absolute locktime CLTV of {} blocks, not met",
n
),
Error::CouldNotSatisfy => f.write_str("could not satisfy"),
Error::BadPubkey(ref e) => fmt::Display::fmt(e, f),
Error::TypeCheck(ref e) => write!(f, "typecheck: {}", e),
Error::BadDescriptor(ref e) => write!(f, "Invalid descriptor: {}", e),
Error::Secp(ref e) => fmt::Display::fmt(e, f),
Error::ContextError(ref e) => fmt::Display::fmt(e, f),
#[cfg(feature = "compiler")]
Error::CompilerError(ref e) => fmt::Display::fmt(e, f),
Error::PolicyError(ref e) => fmt::Display::fmt(e, f),
Error::LiftError(ref e) => fmt::Display::fmt(e, f),
Error::MaxRecursiveDepthExceeded => write!(
f,
"Recursive depth over {} not permitted",
MAX_RECURSION_DEPTH
),
Error::ScriptSizeTooLarge => write!(
f,
"Standardness rules imply bitcoin than {} bytes",
MAX_SCRIPT_SIZE
),
Error::NonStandardBareScript => write!(
f,
"Anything but c:pk(key) (P2PK), c:pk_h(key) (P2PKH), and thresh_m(k,...) \
up to n=3 is invalid by standardness (bare).
"
),
Error::AnalysisError(ref e) => e.fmt(f),
Error::ImpossibleSatisfaction => write!(f, "Impossible to satisfy Miniscript"),
Error::BareDescriptorAddr => write!(f, "Bare descriptors don't have address"),
Error::PubKeyCtxError(ref pk, ref ctx) => {
write!(f, "Pubkey error: {} under {} scriptcontext", pk, ctx)
}
Error::MultiATooManyKeys(k) => {
write!(f, "MultiA too many keys {}", k)
}
Error::TaprootSpendInfoUnavialable => {
write!(f, "Taproot Spend Info not computed.")
}
Error::TrNoScriptCode => {
write!(f, "No script code for Tr descriptors")
}
Error::TrNoExplicitScript => {
write!(f, "No script code for Tr descriptors")
}
}
}
}
impl error::Error for Error {
fn cause(&self) -> Option<&dyn error::Error> {
use self::Error::*;
match self {
InvalidOpcode(_)
| NonMinimalVerify(_)
| InvalidPush(_)
| CmsTooManyKeys(_)
| MultiATooManyKeys(_)
| Unprintable(_)
| ExpectedChar(_)
| UnexpectedStart
| Unexpected(_)
| MultiColon(_)
| MultiAt(_)
| AtOutsideOr(_)
| LikelyFalse
| UnknownWrapper(_)
| NonTopLevel(_)
| Trailing(_)
| MissingHash(_)
| MissingSig(_)
| RelativeLocktimeNotMet(_)
| AbsoluteLocktimeNotMet(_)
| CouldNotSatisfy
| TypeCheck(_)
| BadDescriptor(_)
| MaxRecursiveDepthExceeded
| ScriptSizeTooLarge
| NonStandardBareScript
| ImpossibleSatisfaction
| BareDescriptorAddr
| TaprootSpendInfoUnavialable
| TrNoScriptCode
| TrNoExplicitScript => None,
Script(e) => Some(e),
AddrError(e) => Some(e),
BadPubkey(e) => Some(e),
Secp(e) => Some(e),
#[cfg(feature = "compiler")]
CompilerError(e) => Some(e),
PolicyError(e) => Some(e),
LiftError(e) => Some(e),
ContextError(e) => Some(e),
AnalysisError(e) => Some(e),
PubKeyCtxError(e, _) => Some(e),
}
}
}
#[doc(hidden)]
impl<Pk, Ctx> From<miniscript::types::Error<Pk, Ctx>> for Error
where
Pk: MiniscriptKey,
Ctx: ScriptContext,
{
fn from(e: miniscript::types::Error<Pk, Ctx>) -> Error {
Error::TypeCheck(e.to_string())
}
}
#[doc(hidden)]
impl From<policy::LiftError> for Error {
fn from(e: policy::LiftError) -> Error {
Error::LiftError(e)
}
}
#[doc(hidden)]
impl From<miniscript::context::ScriptContextError> for Error {
fn from(e: miniscript::context::ScriptContextError) -> Error {
Error::ContextError(e)
}
}
#[doc(hidden)]
impl From<miniscript::analyzable::AnalysisError> for Error {
fn from(e: miniscript::analyzable::AnalysisError) -> Error {
Error::AnalysisError(e)
}
}
#[doc(hidden)]
impl From<bitcoin::secp256k1::Error> for Error {
fn from(e: bitcoin::secp256k1::Error) -> Error {
Error::Secp(e)
}
}
#[doc(hidden)]
impl From<bitcoin::util::address::Error> for Error {
fn from(e: bitcoin::util::address::Error) -> Error {
Error::AddrError(e)
}
}
#[doc(hidden)]
#[cfg(feature = "compiler")]
impl From<crate::policy::compiler::CompilerError> for Error {
fn from(e: crate::policy::compiler::CompilerError) -> Error {
Error::CompilerError(e)
}
}
#[doc(hidden)]
impl From<policy::concrete::PolicyError> for Error {
fn from(e: policy::concrete::PolicyError) -> Error {
Error::PolicyError(e)
}
}
fn errstr(s: &str) -> Error {
Error::Unexpected(s.to_owned())
}
/// The size of an encoding of a number in Script
pub fn script_num_size(n: usize) -> usize {
match n {
n if n <= 0x10 => 1, // OP_n
n if n < 0x80 => 2, // OP_PUSH1 <n>
n if n < 0x8000 => 3, // OP_PUSH2 <n>
n if n < 0x800000 => 4, // OP_PUSH3 <n>
n if n < 0x80000000 => 5, // OP_PUSH4 <n>
_ => 6, // OP_PUSH5 <n>
}
}
/// Returns the size of the smallest push opcode used to push a given number of bytes onto the stack
///
/// For sizes ≤ 75, there are dedicated single-byte opcodes, so the push size is one. Otherwise,
/// if the size can fit into 1, 2 or 4 bytes, we use the `PUSHDATA{1,2,4}` opcode respectively,
/// followed by the actual size encoded in that many bytes.
fn push_opcode_size(script_size: usize) -> usize {
if script_size < 76 {
1
} else if script_size < 0x100 {
2
} else if script_size < 0x10000 {
3
} else {
5
}
}
/// Helper function used by tests
#[cfg(test)]
fn hex_script(s: &str) -> bitcoin::Script {
let v: Vec<u8> = bitcoin::hashes::hex::FromHex::from_hex(s).unwrap();
bitcoin::Script::from(v)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn regression_bitcoin_key_hash() {
use bitcoin::PublicKey;
// Uncompressed key.
let pk = PublicKey::from_str(
"042e58afe51f9ed8ad3cc7897f634d881fdbe49a81564629ded8156bebd2ffd1af191923a2964c177f5b5923ae500fca49e99492d534aa3759d6b25a8bc971b133"
).unwrap();
let want = hash160::Hash::from_str("ac2e7daf42d2c97418fd9f78af2de552bb9c6a7a").unwrap();
let got = pk.to_pubkeyhash();
assert_eq!(got, want)
}
#[test]
fn regression_secp256k1_key_hash() {
use bitcoin::secp256k1::PublicKey;
// Compressed key.
let pk = PublicKey::from_str(
"032e58afe51f9ed8ad3cc7897f634d881fdbe49a81564629ded8156bebd2ffd1af",
)
.unwrap();
let want = hash160::Hash::from_str("9511aa27ef39bbfa4e4f3dd15f4d66ea57f475b4").unwrap();
let got = pk.to_pubkeyhash();
assert_eq!(got, want)
}
#[test]
fn regression_xonly_key_hash() {
use bitcoin::secp256k1::XOnlyPublicKey;
let pk = XOnlyPublicKey::from_str(
"cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115",
)
.unwrap();
let want = hash160::Hash::from_str("eb8ac65f971ae688a94aeabf223506865e7e08f2").unwrap();
let got = pk.to_pubkeyhash();
assert_eq!(got, want)
}
#[test]
fn regression_string_key_hash() {
let pk = String::from("some-key-hash-string");
let hash = pk.to_pubkeyhash();
assert_eq!(hash, pk)
}
}