Struct schnorr_fun::musig::AggKey

pub struct AggKey<T> { /* private fields */ }

A list of keys aggregated into a single key.

Created using MuSig::new_agg_key.

The AggKey can’t be serialized but it’s very efficient to re-create it from the initial list of keys.

MuSig::new_agg_key

Implementations

impl<T: Copy> AggKey<T>

pub fn agg_public_key(&self) -> Point<T>

The aggregate key.

Note that before using it as a key in a system that accepts “x-only” keys like [BIP341] you must call into_xonly_key and use that aggregate key.

pub fn keys(&self) -> impl Iterator<Item = Point> + '_

An iterator over the public keys of each party in the aggregate key.

impl AggKey<Normal>

pub fn into_xonly_key(self) -> AggKey<EvenY>

Convert the key into a BIP340 AggKey.

This is the BIP340 x-only version of the key which you can put in a segwitv1 output and create/verify BIP340 signatures under.

pub fn tweak(self, tweak: Scalar<impl Secrecy, impl ZeroChoice>) -> Option<Self>

Add a scalar tweak to aggregate MuSig public key.

The resulting key is equal to the existing key plus tweak * G. The tweak mutates the public key while still allowing the original set of signers to sign under the new key. This function is appropriate for doing BIP32 tweaks before calling into_xonly_key. It is not appropriate for doing taproot tweaking which must be done on an AggKey with EvenY public key in BIP340 form, see into_xonly_key.

Return value

In the erroneous case that the tweak is exactly equal to the negation of the aggregate secret key it returns None.

impl AggKey<EvenY>

pub fn tweak(self, tweak: Scalar<impl Secrecy, impl ZeroChoice>) -> Option<Self>

Applies an “x-only” tweak to the aggregate key.

This function exists to allow for BIP341 tweaks to the aggregate public key.

Trait Implementations

impl<T: Clone> Clone for AggKey<T>

fn clone(&self) -> AggKey<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AggKey<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.