]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/sign/taproot.rs
f2d3f62831374a5091d55a9825f46e494f66e459
[rust-lightning] / lightning / src / sign / taproot.rs
1 //! Defines a Taproot-specific signer type.
2
3 use alloc::vec::Vec;
4 use bitcoin::blockdata::transaction::Transaction;
5 use bitcoin::secp256k1;
6 use bitcoin::secp256k1::{PublicKey, schnorr::Signature, Secp256k1, SecretKey};
7
8 use musig2::types::{PartialSignature, PublicNonce};
9
10 use crate::ln::chan_utils::{ClosingTransaction, CommitmentTransaction, HolderCommitmentTransaction, HTLCOutputInCommitment};
11 use crate::ln::msgs::PartialSignatureWithNonce;
12 use crate::ln::PaymentPreimage;
13 use crate::sign::{ChannelSigner, HTLCDescriptor};
14
15 /// A Taproot-specific signer type that defines signing-related methods that are either unique to
16 /// Taproot or have argument or return types that differ from the ones an ECDSA signer would be
17 /// expected to have.
18 pub trait TaprootChannelSigner: ChannelSigner {
19         /// Generate a local nonce pair, which requires committing to ahead of time.
20         /// The counterparty needs the public nonce generated herein to compute a partial signature.
21         fn generate_local_nonce_pair(&self, commitment_number: u64, secp_ctx: &Secp256k1<secp256k1::All>) -> PublicNonce;
22
23         /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
24         ///
25         /// Note that if signing fails or is rejected, the channel will be force-closed.
26         ///
27         /// Policy checks should be implemented in this function, including checking the amount
28         /// sent to us and checking the HTLCs.
29         ///
30         /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
31         /// A validating signer should ensure that an HTLC output is removed only when the matching
32         /// preimage is provided, or when the value to holder is restored.
33         ///
34         /// Note that all the relevant preimages will be provided, but there may also be additional
35         /// irrelevant or duplicate preimages.
36         //
37         // TODO: Document the things someone using this interface should enforce before signing.
38         fn partially_sign_counterparty_commitment(&self, counterparty_nonce: PublicNonce,
39                 commitment_tx: &CommitmentTransaction, preimages: Vec<PaymentPreimage>,
40                 secp_ctx: &Secp256k1<secp256k1::All>,
41         ) -> Result<(PartialSignatureWithNonce, Vec<Signature>), ()>;
42
43         /// Creates a signature for a holder's commitment transaction.
44         ///
45         /// This will be called
46         /// - with a non-revoked `commitment_tx`.
47         /// - with the latest `commitment_tx` when we initiate a force-close.
48         ///
49         /// This may be called multiple times for the same transaction.
50         ///
51         /// An external signer implementation should check that the commitment has not been revoked.
52         ///
53         // TODO: Document the things someone using this interface should enforce before signing.
54         fn finalize_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction,
55                 counterparty_partial_signature: PartialSignatureWithNonce,
56                 secp_ctx: &Secp256k1<secp256k1::All>
57         ) -> Result<PartialSignature, ()>;
58
59         /// Create a signature for the given input in a transaction spending an HTLC transaction output
60         /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
61         ///
62         /// A justice transaction may claim multiple outputs at the same time if timelocks are
63         /// similar, but only a signature for the input at index `input` should be signed for here.
64         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
65         /// to an upcoming timelock expiration.
66         ///
67         /// Amount is value of the output spent by this input, committed to in the BIP 341 signature.
68         ///
69         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
70         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
71         /// not allow the spending of any funds by itself (you need our holder `revocation_secret` to do
72         /// so).
73         fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64,
74                 per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>,
75         ) -> Result<Signature, ()>;
76
77         /// Create a signature for the given input in a transaction spending a commitment transaction
78         /// HTLC output when our counterparty broadcasts an old state.
79         ///
80         /// A justice transaction may claim multiple outputs at the same time if timelocks are
81         /// similar, but only a signature for the input at index `input` should be signed for here.
82         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
83         /// to an upcoming timelock expiration.
84         ///
85         /// `amount` is the value of the output spent by this input, committed to in the BIP 341
86         /// signature.
87         ///
88         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
89         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
90         /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
91         /// so).
92         ///
93         /// `htlc` holds HTLC elements (hash, timelock), thus changing the format of the witness script
94         /// (which is committed to in the BIP 341 signatures).
95         fn sign_justice_revoked_htlc(&self, justice_tx: &Transaction, input: usize, amount: u64,
96                 per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment,
97                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
98
99         /// Computes the signature for a commitment transaction's HTLC output used as an input within
100         /// `htlc_tx`, which spends the commitment transaction at index `input`. The signature returned
101         /// must be be computed using [`TapSighashType::Default`].
102         ///
103         /// Note that this may be called for HTLCs in the penultimate commitment transaction if a
104         /// [`ChannelMonitor`] [replica](https://github.com/lightningdevkit/rust-lightning/blob/main/GLOSSARY.md#monitor-replicas)
105         /// broadcasts it before receiving the update for the latest commitment transaction.
106         ///
107         ///
108         /// [`TapSighashType::Default`]: bitcoin::sighash::TapSighashType::Default
109         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
110         fn sign_holder_htlc_transaction(&self, htlc_tx: &Transaction, input: usize,
111                 htlc_descriptor: &HTLCDescriptor, secp_ctx: &Secp256k1<secp256k1::All>,
112         ) -> Result<Signature, ()>;
113
114         /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
115         /// transaction, either offered or received.
116         ///
117         /// Such a transaction may claim multiples offered outputs at same time if we know the
118         /// preimage for each when we create it, but only the input at index `input` should be
119         /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
120         /// needed with regards to an upcoming timelock expiration.
121         ///
122         /// `witness_script` is either an offered or received script as defined in BOLT3 for HTLC
123         /// outputs.
124         ///
125         /// `amount` is value of the output spent by this input, committed to in the BIP 341 signature.
126         ///
127         /// `per_commitment_point` is the dynamic point corresponding to the channel state
128         /// detected onchain. It has been generated by our counterparty and is used to derive
129         /// channel state keys, which are then included in the witness script and committed to in the
130         /// BIP 341 signature.
131         fn sign_counterparty_htlc_transaction(&self, htlc_tx: &Transaction, input: usize, amount: u64,
132                 per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment,
133                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
134
135         /// Create a signature for a (proposed) closing transaction.
136         ///
137         /// Note that, due to rounding, there may be one "missing" satoshi, and either party may have
138         /// chosen to forgo their output as dust.
139         fn partially_sign_closing_transaction(&self, closing_tx: &ClosingTransaction,
140                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<PartialSignature, ()>;
141
142         /// Computes the signature for a commitment transaction's anchor output used as an
143         /// input within `anchor_tx`, which spends the commitment transaction, at index `input`.
144         fn sign_holder_anchor_input(
145                 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
146         ) -> Result<Signature, ()>;
147
148         // TODO: sign channel announcement
149 }