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

New descriptor type system capable of supporting tapret commitments #62

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
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
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

120 changes: 120 additions & 0 deletions descriptors/src/descriptors2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
//! Experiments on new descriptor type system

#![allow(unused)]

use std::collections::HashMap;
use std::hash::Hash;

use amplify::Slice32;
use bitcoin::util::bip32::ChainCode;
use bitcoin::XOnlyPublicKey;
use bitcoin_hd::{DerivationSubpath, TerminalStep, UnhardenedIndex};
use bitcoin_scripts::address::AddressPayload;
use bitcoin_scripts::{LeafScript, TapNodeHash};
use miniscript_crate::{Legacy, Miniscript, MiniscriptKey, Segwitv0, Tap};

pub trait ScriptData: MiniscriptKey {
type Key;
type CompKey;
type XonlyKey;
type Definite;
}

pub trait Descriptor {
type Translated;
fn translate(&self) -> Self::Translated;
}

pub struct AccDescr<D: ScriptData, K: ScriptData, const TERM_LEN: usize> {
keys: HashMap<D, K>,
descr: OutputDescr<D>,
terminal: Option<DerivationSubpath<TerminalStep>>,
tapret: Vec<TapretInfo<TERM_LEN>>,
}

pub struct TapretInfo<const TERM_LEN: usize> {
pub terminal: [UnhardenedIndex; TERM_LEN],
pub nonce: u8,
pub tweak: Slice32,
}

impl<D: ScriptData, K: ScriptData, const TERM_LEN: usize> Descriptor for AccDescr<D, K, TERM_LEN> {
type Translated = K::Definite;
fn translate(&self) -> K::Definite { todo!() }
}

// Temporary type holder
pub type AccId = Slice32;
// Temporary type holder
pub type AccStateId = Slice32;

impl<D: ScriptData, K: ScriptData, const TERM_LEN: usize> AccDescr<D, K, TERM_LEN> {
pub fn id() -> AccId { todo!("commit to permanent parts") }
pub fn state_id() -> AccStateId { todo!("commit to variable parts") }
}

pub enum OutputDescr<D: ScriptData> {
Sh(ScriptDescr<D>),
Wsh(WScriptDescr<D>),
Pk(D),
Pkh(D),
Wpkh(D),

Combo(ComboDescr<D>),
Multi(MultiDescr<D, false>),
Sortedmulti(MultiDescr<D, true>),

Tr(TapKeyDescr<D>, TapNodeDescr<D>),

Raw(ScriptDescr<D>),
RawTr(XOnlyPublicKey),

Addr(AddressPayload),
}

pub enum ScriptDescr<D: ScriptData> {
Bitcoin(BitcoinScript<D>),
Miniscript(Miniscript<D, Legacy>),
}

pub enum WScriptDescr<D: ScriptData> {
Bitcoin(BitcoinScript<D>),
Miniscript(Miniscript<D, Segwitv0>),
}

pub struct ComboDescr<D: ScriptData>(Vec<D> /* at least 1 element, no repeated elements */);

pub struct MultiDescr<D: ScriptData, const SORTED: bool> {
threshold: u8,
keys: Vec<D>, // at least 1 element, no repeated elements, ensure # >= threshold
}

pub enum TapKeyDescr<D: ScriptData> {
Unspend(ChainCode, DerivationSubpath<TerminalStep>),
Key(D),
MuSig(Vec<D>),
}

pub enum TapNodeDescr<D: ScriptData> {
TapScript(TapScript<D>),
TapMiniscript(Miniscript<D, Tap>),
RawLeaf(LeafScript),
RawNode(TapNodeHash),
Branch(Box<TapNodeDescr<D>>, Box<TapNodeDescr<D>>),
}

pub struct BitcoinScript<D: ScriptData> {
instructions: Vec<LegacyInstr<D>>,
}

pub struct TapScript<D: ScriptData> {
instructions: Vec<TapInstr<D>>,
}

pub enum LegacyInstr<D: ScriptData> {
Data(D), // enumerate opcodes
}

pub enum TapInstr<D: ScriptData> {
Data(D), // enumerate opcodes
}
1 change: 1 addition & 0 deletions descriptors/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ extern crate serde_crate as serde;
mod deduction;
pub mod derive;
mod descriptor;
pub mod descriptors2;
mod input;
#[cfg(feature = "miniscript")]
mod templates;
Expand Down