Skip to content

Commit 7de96d3

Browse files
apoelstraapoelstra
committed
policy: split up error enum for concrete and semantic
1 parent 1f9fdb8 commit 7de96d3

File tree

4 files changed

+57
-41
lines changed

4 files changed

+57
-41
lines changed

‎src/lib.rs‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,9 @@ pub enum Error {
464464
/// Compiler related errors
465465
CompilerError(crate::policy::compiler::CompilerError),
466466
/// Errors related to policy
467-
PolicyError(policy::concrete::PolicyError),
467+
SemanticPolicy(policy::semantic::PolicyError),
468+
/// Errors related to policy
469+
ConcretePolicy(policy::concrete::PolicyError),
468470
/// Errors related to lifting
469471
LiftError(policy::LiftError),
470472
/// Forward script context related errors
@@ -529,7 +531,8 @@ impl fmt::Display for Error {
529531
Error::ContextError(ref e) => fmt::Display::fmt(e, f),
530532
#[cfg(feature = "compiler")]
531533
Error::CompilerError(ref e) => fmt::Display::fmt(e, f),
532-
Error::PolicyError(ref e) => fmt::Display::fmt(e, f),
534+
Error::SemanticPolicy(ref e) => fmt::Display::fmt(e, f),
535+
Error::ConcretePolicy(ref e) => fmt::Display::fmt(e, f),
533536
Error::LiftError(ref e) => fmt::Display::fmt(e, f),
534537
Error::MaxRecursiveDepthExceeded => write!(
535538
f,
@@ -595,7 +598,8 @@ impl error::Error for Error {
595598
Secp(e) => Some(e),
596599
#[cfg(feature = "compiler")]
597600
CompilerError(e) => Some(e),
598-
PolicyError(e) => Some(e),
601+
ConcretePolicy(e) => Some(e),
602+
SemanticPolicy(e) => Some(e),
599603
LiftError(e) => Some(e),
600604
ContextError(e) => Some(e),
601605
AnalysisError(e) => Some(e),
@@ -649,11 +653,6 @@ impl From<crate::policy::compiler::CompilerError> for Error {
649653
fn from(e: crate::policy::compiler::CompilerError) -> Error { Error::CompilerError(e) }
650654
}
651655

652-
#[doc(hidden)]
653-
impl From<policy::concrete::PolicyError> for Error {
654-
fn from(e: policy::concrete::PolicyError) -> Error { Error::PolicyError(e) }
655-
}
656-
657656
fn errstr(s: &str) -> Error { Error::Unexpected(s.to_owned()) }
658657

659658
/// The size of an encoding of a number in Script

‎src/policy/concrete.rs‎

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ use {
2121
core::cmp::Reverse,
2222
};
2323

24-
use super::ENTAILMENT_MAX_TERMINALS;
2524
use crate::expression::{self, FromTree};
2625
use crate::iter::{Tree, TreeLike};
2726
use crate::miniscript::types::extra_props::TimelockInfo;
@@ -80,12 +79,6 @@ pub enum PolicyError {
8079
NonBinaryArgAnd,
8180
/// `Or` fragments only support two args.
8281
NonBinaryArgOr,
83-
/// Semantic Policy Error: `And` `Or` fragments must take args: `k > 1`.
84-
InsufficientArgsforAnd,
85-
/// Semantic policy error: `And` `Or` fragments must take args: `k > 1`.
86-
InsufficientArgsforOr,
87-
/// Entailment max terminals exceeded.
88-
EntailmentMaxTerminals,
8982
/// Cannot lift policies that have a combination of height and timelocks.
9083
HeightTimelockCombination,
9184
/// Duplicate Public Keys.
@@ -114,15 +107,6 @@ impl fmt::Display for PolicyError {
114107
f.write_str("And policy fragment must take 2 arguments")
115108
}
116109
PolicyError::NonBinaryArgOr => f.write_str("Or policy fragment must take 2 arguments"),
117-
PolicyError::InsufficientArgsforAnd => {
118-
f.write_str("Semantic Policy 'And' fragment must have at least 2 args ")
119-
}
120-
PolicyError::InsufficientArgsforOr => {
121-
f.write_str("Semantic Policy 'Or' fragment must have at least 2 args ")
122-
}
123-
PolicyError::EntailmentMaxTerminals => {
124-
write!(f, "Policy entailment only supports {} terminals", ENTAILMENT_MAX_TERMINALS)
125-
}
126110
PolicyError::HeightTimelockCombination => {
127111
f.write_str("Cannot lift policies that have a heightlock and timelock combination")
128112
}
@@ -137,13 +121,7 @@ impl error::Error for PolicyError {
137121
use self::PolicyError::*;
138122

139123
match self {
140-
NonBinaryArgAnd
141-
| NonBinaryArgOr
142-
| InsufficientArgsforAnd
143-
| InsufficientArgsforOr
144-
| EntailmentMaxTerminals
145-
| HeightTimelockCombination
146-
| DuplicatePubKeys => None,
124+
NonBinaryArgAnd | NonBinaryArgOr | HeightTimelockCombination | DuplicatePubKeys => None,
147125
}
148126
}
149127
}
@@ -252,7 +230,7 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
252230
// TODO: We might require other compile errors for Taproot.
253231
#[cfg(feature = "compiler")]
254232
pub fn compile_tr(&self, unspendable_key: Option<Pk>) -> Result<Descriptor<Pk>, Error> {
255-
self.is_valid()?; // Check for validity
233+
self.is_valid().map_err(Error::ConcretePolicy)?;
256234
match self.is_safe_nonmalleable() {
257235
(false, _) => Err(Error::from(CompilerError::TopLevelNonSafe)),
258236
(_, false) => Err(Error::from(CompilerError::ImpossibleNonMalleableCompilation)),
@@ -308,7 +286,7 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
308286
&self,
309287
unspendable_key: Option<Pk>,
310288
) -> Result<Descriptor<Pk>, Error> {
311-
self.is_valid()?; // Check for validity
289+
self.is_valid().map_err(Error::ConcretePolicy)?;
312290
match self.is_safe_nonmalleable() {
313291
(false, _) => Err(Error::from(CompilerError::TopLevelNonSafe)),
314292
(_, false) => Err(Error::from(CompilerError::ImpossibleNonMalleableCompilation)),
@@ -355,7 +333,7 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
355333
&self,
356334
desc_ctx: DescriptorCtx<Pk>,
357335
) -> Result<Descriptor<Pk>, Error> {
358-
self.is_valid()?;
336+
self.is_valid().map_err(Error::ConcretePolicy)?;
359337
match self.is_safe_nonmalleable() {
360338
(false, _) => Err(Error::from(CompilerError::TopLevelNonSafe)),
361339
(_, false) => Err(Error::from(CompilerError::ImpossibleNonMalleableCompilation)),
@@ -869,7 +847,7 @@ impl<Pk: FromStrKey> str::FromStr for Policy<Pk> {
869847

870848
let tree = expression::Tree::from_str(s)?;
871849
let policy: Policy<Pk> = FromTree::from_tree(&tree)?;
872-
policy.check_timelocks()?;
850+
policy.check_timelocks().map_err(Error::ConcretePolicy)?;
873851
Ok(policy)
874852
}
875853
}
@@ -934,7 +912,7 @@ impl<Pk: FromStrKey> Policy<Pk> {
934912
}),
935913
("and", _) => {
936914
if top.args.len() != 2 {
937-
return Err(Error::PolicyError(PolicyError::NonBinaryArgAnd));
915+
return Err(Error::ConcretePolicy(PolicyError::NonBinaryArgAnd));
938916
}
939917
let mut subs = Vec::with_capacity(top.args.len());
940918
for arg in &top.args {
@@ -944,7 +922,7 @@ impl<Pk: FromStrKey> Policy<Pk> {
944922
}
945923
("or", _) => {
946924
if top.args.len() != 2 {
947-
return Err(Error::PolicyError(PolicyError::NonBinaryArgOr));
925+
return Err(Error::ConcretePolicy(PolicyError::NonBinaryArgOr));
948926
}
949927
let mut subs = Vec::with_capacity(top.args.len());
950928
for arg in &top.args {

‎src/policy/mod.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ impl<Pk: MiniscriptKey> Liftable<Pk> for Concrete<Pk> {
194194
fn lift(&self) -> Result<Semantic<Pk>, Error> {
195195
// do not lift if there is a possible satisfaction
196196
// involving combination of timelocks and heightlocks
197-
self.check_timelocks()?;
197+
self.check_timelocks().map_err(Error::ConcretePolicy)?;
198198
let ret = match *self {
199199
Concrete::Unsatisfiable => Semantic::Unsatisfiable,
200200
Concrete::Trivial => Semantic::Trivial,

‎src/policy/semantic.rs‎

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
88
use core::str::FromStr;
99
use core::{fmt, str};
10+
#[cfg(feature = "std")]
11+
use std::error;
1012

1113
use bitcoin::{absolute, relative};
1214

13-
use super::concrete::PolicyError;
1415
use super::ENTAILMENT_MAX_TERMINALS;
1516
use crate::iter::{Tree, TreeLike};
1617
use crate::prelude::*;
@@ -50,6 +51,44 @@ pub enum Policy<Pk: MiniscriptKey> {
5051
Thresh(Threshold<Arc<Policy<Pk>>, 0>),
5152
}
5253

54+
/// Detailed error type for concrete policies.
55+
#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
56+
pub enum PolicyError {
57+
/// Semantic Policy Error: `And` `Or` fragments must take args: `k > 1`.
58+
InsufficientArgsforAnd,
59+
/// Semantic policy error: `And` `Or` fragments must take args: `k > 1`.
60+
InsufficientArgsforOr,
61+
/// Entailment max terminals exceeded.
62+
EntailmentMaxTerminals,
63+
}
64+
65+
impl fmt::Display for PolicyError {
66+
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
67+
match *self {
68+
PolicyError::InsufficientArgsforAnd => {
69+
f.write_str("Semantic Policy 'And' fragment must have at least 2 args ")
70+
}
71+
PolicyError::InsufficientArgsforOr => {
72+
f.write_str("Semantic Policy 'Or' fragment must have at least 2 args ")
73+
}
74+
PolicyError::EntailmentMaxTerminals => {
75+
write!(f, "Policy entailment only supports {} terminals", ENTAILMENT_MAX_TERMINALS)
76+
}
77+
}
78+
}
79+
}
80+
81+
#[cfg(feature = "std")]
82+
impl error::Error for PolicyError {
83+
fn cause(&self) -> Option<&dyn error::Error> {
84+
match self {
85+
PolicyError::InsufficientArgsforAnd
86+
| PolicyError::InsufficientArgsforOr
87+
| PolicyError::EntailmentMaxTerminals => None,
88+
}
89+
}
90+
}
91+
5392
impl<Pk: MiniscriptKey> ForEachKey<Pk> for Policy<Pk> {
5493
fn for_each_key<'a, F: FnMut(&'a Pk) -> bool>(&'a self, mut pred: F) -> bool {
5594
self.pre_order_iter().all(|policy| match policy {
@@ -312,7 +351,7 @@ impl<Pk: FromStrKey> expression::FromTree for Policy<Pk> {
312351
}),
313352
("and", nsubs) => {
314353
if nsubs < 2 {
315-
return Err(Error::PolicyError(PolicyError::InsufficientArgsforAnd));
354+
return Err(Error::SemanticPolicy(PolicyError::InsufficientArgsforAnd));
316355
}
317356
let mut subs = Vec::with_capacity(nsubs);
318357
for arg in &top.args {
@@ -322,7 +361,7 @@ impl<Pk: FromStrKey> expression::FromTree for Policy<Pk> {
322361
}
323362
("or", nsubs) => {
324363
if nsubs < 2 {
325-
return Err(Error::PolicyError(PolicyError::InsufficientArgsforOr));
364+
return Err(Error::SemanticPolicy(PolicyError::InsufficientArgsforOr));
326365
}
327366
let mut subs = Vec::with_capacity(nsubs);
328367
for arg in &top.args {

0 commit comments

Comments
 (0)