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

Support WPKH descriptors #88

Merged
merged 2 commits into from
Jan 5, 2024
Merged
Show file tree
Hide file tree
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
10 changes: 8 additions & 2 deletions cli/src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,34 @@
#![allow(clippy::needless_update)] // Caused by the From derivation macro

use bp_util::{Config, DescriptorOpts};
use bpstd::XpubDerivable;
use bpstd::{Wpkh, XpubDerivable};
use rgb_rt::{Resolver, ResolverError, RgbDescr, Runtime, RuntimeError, TapretKey};

use crate::Command;

#[derive(Args, Clone, PartialEq, Eq, Debug)]
#[group()]
pub struct DescrRgbOpts {
/// Use tapret(KEY) descriptor as wallet.
#[arg(long, global = true)]
pub tapret_key_only: Option<XpubDerivable>,

/// Use wpkh(KEY) descriptor as wallet.
#[arg(long, global = true)]
pub wpkh: Option<XpubDerivable>,
}

impl DescriptorOpts for DescrRgbOpts {
type Descr = RgbDescr;

fn is_some(&self) -> bool { self.tapret_key_only.is_some() }
fn is_some(&self) -> bool { self.tapret_key_only.is_some() || self.wpkh.is_some() }

fn descriptor(&self) -> Option<Self::Descr> {
self.tapret_key_only
.clone()
.map(TapretKey::from)
.map(TapretKey::into)
.or(self.wpkh.clone().map(Wpkh::from).map(Wpkh::into))
}
}

Expand Down
22 changes: 18 additions & 4 deletions src/descriptor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ use bpstd::{
TapTree, Terminal, XOnlyPk, XpubDerivable, XpubSpec,
};
use commit_verify::CommitVerify;
use descriptors::{Descriptor, SpkClass, StdDescr, TrKey};
use descriptors::{Descriptor, SpkClass, StdDescr, TrKey, Wpkh};
use indexmap::IndexMap;

#[derive(Copy, Clone, Eq, PartialEq, Debug, Display, Error)]
Expand Down Expand Up @@ -229,30 +229,36 @@ impl<K: DeriveXOnly> DescriptorRgb<K> for TapretKey<K> {
crate = "serde_crate",
rename_all = "camelCase",
bound(
serialize = "S::XOnly: serde::Serialize",
deserialize = "S::XOnly: serde::Deserialize<'de>"
serialize = "S::Compr: serde::Serialize, S::XOnly: serde::Serialize",
deserialize = "S::Compr: serde::Deserialize<'de>, S::XOnly: serde::Deserialize<'de>"
)
)]
#[non_exhaustive]
pub enum RgbDescr<S: DeriveSet = XpubDerivable> {
#[from]
Wpkh(Wpkh<S::Compr>),
#[from]
TapretKey(TapretKey<S::XOnly>),
}

impl<S: DeriveSet> Derive<DerivedScript> for RgbDescr<S> {
fn default_keychain(&self) -> Keychain {
match self {
RgbDescr::Wpkh(d) => d.default_keychain(),
RgbDescr::TapretKey(d) => d.default_keychain(),
}
}

fn keychains(&self) -> BTreeSet<Keychain> {
match self {
RgbDescr::Wpkh(d) => d.keychains(),
RgbDescr::TapretKey(d) => d.keychains(),
}
}

fn derive(&self, change: impl Into<Keychain>, index: impl Into<NormalIndex>) -> DerivedScript {
match self {
RgbDescr::Wpkh(d) => d.derive(change, index),
RgbDescr::TapretKey(d) => d.derive(change, index),
}
}
Expand All @@ -267,38 +273,44 @@ where Self: Derive<DerivedScript>

fn class(&self) -> SpkClass {
match self {
RgbDescr::Wpkh(d) => d.class(),
RgbDescr::TapretKey(d) => d.class(),
}
}

fn keys(&self) -> Self::KeyIter<'_> {
match self {
RgbDescr::Wpkh(d) => d.keys().collect::<Vec<_>>(),
RgbDescr::TapretKey(d) => d.keys().collect::<Vec<_>>(),
}
.into_iter()
}

fn vars(&self) -> Self::VarIter<'_> {
match self {
RgbDescr::Wpkh(d) => d.vars(),
RgbDescr::TapretKey(d) => d.vars(),
}
}

fn xpubs(&self) -> Self::XpubIter<'_> {
match self {
RgbDescr::Wpkh(d) => d.xpubs().collect::<Vec<_>>(),
RgbDescr::TapretKey(d) => d.xpubs().collect::<Vec<_>>(),
}
.into_iter()
}

fn compr_keyset(&self, terminal: Terminal) -> IndexMap<CompressedPk, KeyOrigin> {
match self {
RgbDescr::Wpkh(d) => d.compr_keyset(terminal),
RgbDescr::TapretKey(d) => d.compr_keyset(terminal),
}
}

fn xonly_keyset(&self, terminal: Terminal) -> IndexMap<XOnlyPk, TapDerivation> {
match self {
RgbDescr::Wpkh(d) => d.xonly_keyset(terminal),
RgbDescr::TapretKey(d) => d.xonly_keyset(terminal),
}
}
Expand All @@ -310,6 +322,7 @@ where Self: Derive<DerivedScript>
{
fn seal_close_method(&self) -> CloseMethod {
match self {
RgbDescr::Wpkh(_) => CloseMethod::OpretFirst,
RgbDescr::TapretKey(d) => d.seal_close_method(),
}
}
Expand All @@ -320,6 +333,7 @@ where Self: Derive<DerivedScript>
tweak: TapretCommitment,
) -> Result<(), TapTweakAlreadyAssigned> {
match self {
RgbDescr::Wpkh(_) => panic!("adding tapret tweak to non-taproot descriptor"),
RgbDescr::TapretKey(d) => d.add_tapret_tweak(terminal, tweak),
}
}
Expand All @@ -328,7 +342,7 @@ where Self: Derive<DerivedScript>
impl From<StdDescr> for RgbDescr {
fn from(descr: StdDescr) -> Self {
match descr {
StdDescr::Wpkh(_) => todo!(),
StdDescr::Wpkh(wpkh) => RgbDescr::Wpkh(wpkh),
StdDescr::TrKey(tr) => RgbDescr::TapretKey(tr.into()),
_ => todo!(),
}
Expand Down
Loading