Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow direct compilation of a Policy into a valid Descriptor #352

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/policy/concrete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,21 @@ pub enum PolicyError {
DuplicatePubKeys,
}

/// Descriptor context for [`Policy`] compilation into a [`Descriptor`]
pub enum DescriptorCtx<Pk> {
/// [Bare][`Descriptor::Bare`]
Bare,
/// [Sh][`Descriptor::Sh`]
Sh,
/// [Wsh][`Descriptor::Wsh`]
Wsh,
/// Sh-wrapped [Wsh][`Descriptor::Wsh`]
ShWsh,
/// [Tr][`Descriptor::Tr`] where the Option<Pk> corresponds to the internal_key if no internal
/// key can be inferred from the given policy
Tr(Option<Pk>),
}

impl fmt::Display for PolicyError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
Expand Down Expand Up @@ -289,6 +304,31 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
}
}

/// Compile the [`Policy`] into desc_ctx [`Descriptor`]
///
/// In case of [Tr][`DescriptorCtx::Tr`], `internal_key` is used for the Taproot comilation when
/// no public key can be inferred from the given policy
#[cfg(feature = "compiler")]
pub fn compile_to_descriptor<Ctx: ScriptContext>(
SarcasticNastik marked this conversation as resolved.
Show resolved Hide resolved
&self,
desc_ctx: DescriptorCtx<Pk>,
) -> Result<Descriptor<Pk>, Error> {
self.is_valid()?;
match self.is_safe_nonmalleable() {
(false, _) => Err(Error::from(CompilerError::TopLevelNonSafe)),
(_, false) => Err(Error::from(
CompilerError::ImpossibleNonMalleableCompilation,
)),
_ => match desc_ctx {
DescriptorCtx::Bare => Descriptor::new_bare(compiler::best_compilation(self)?),
DescriptorCtx::Sh => Descriptor::new_sh(compiler::best_compilation(self)?),
DescriptorCtx::Wsh => Descriptor::new_wsh(compiler::best_compilation(self)?),
DescriptorCtx::ShWsh => Descriptor::new_sh_wsh(compiler::best_compilation(self)?),
DescriptorCtx::Tr(unspendable_key) => self.compile_tr(unspendable_key),
},
}
}

/// Compile the descriptor into an optimized `Miniscript` representation
#[cfg(feature = "compiler")]
pub fn compile<Ctx: ScriptContext>(&self) -> Result<Miniscript<Pk, Ctx>, CompilerError> {
Expand Down