Skip to content

Remove context from the API #844

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
Sep 16, 2025
Merged

Remove context from the API #844

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b2cdc98
docs: Remove one instance of context construction
tcharding Sep 11, 2025
95e2e25
Use super::* in tests
tcharding Sep 10, 2025
792103b
Remove context from PublicKey::from_secret_key
tcharding Sep 9, 2025
f8bf19d
Remove context from tweaking functions
tcharding Sep 9, 2025
074a4ac
Remove context from Keypair functions
tcharding Sep 9, 2025
403f541
Remove context from verification functions
tcharding Sep 10, 2025
58c7ba2
Remove context from signing APIs
tcharding Sep 10, 2025
70e928c
musig: Remove context
tcharding Sep 10, 2025
4fe0101
ellswift: Remove context
tcharding Sep 10, 2025
38a7d9e
Remove context sort_pubkeys
tcharding Sep 10, 2025
3f5c666
Remove unneeded import
tcharding Sep 10, 2025
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
123 changes: 71 additions & 52 deletions src/key/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,15 +307,21 @@ impl PublicKey {
///
/// Returns an error if the resulting key would be invalid.
#[inline]
pub fn mul_tweak<C: Verification>(
mut self,
secp: &Secp256k1<C>,
other: &Scalar,
) -> Result<PublicKey, Error> {
pub fn mul_tweak(mut self, other: &Scalar) -> Result<PublicKey, Error> {
// We have no seed here but we want rerandomiziation to happen for `rand` users.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In f8bf19d:

There is no secret data. We don't want to rerandomize here. It slows things down for no purpose.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with every other instance, even KeyPair, because while we manipulate secret data there, it's not in a way that rerandomization would have any effect on.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit is still present in the latest push (but I can address it in a followup).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I missed this comment yesterday. Fixed in #855

let seed = [0_u8; 32];
unsafe {
if ffi::secp256k1_ec_pubkey_tweak_mul(secp.ctx.as_ptr(), &mut self.0, other.as_c_ptr())
== 1
{
let res = crate::with_global_context(
|secp: &Secp256k1<crate::AllPreallocated>| {
ffi::secp256k1_ec_pubkey_tweak_mul(
secp.ctx.as_ptr(),
&mut self.0,
other.as_c_ptr(),
)
},
Some(&seed),
);
if res == 1 {
Ok(self)
} else {
Err(Error::InvalidTweak)
Expand Down Expand Up @@ -649,21 +655,24 @@ impl Keypair {
/// let tweak = Scalar::random();
///
/// let mut keypair = Keypair::new(&secp, &mut rand::rng());
/// let tweaked = keypair.add_xonly_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
/// let tweaked = keypair.add_xonly_tweak(&tweak).expect("Improbable to fail with a randomly generated tweak");
/// # }
/// ```
// TODO: Add checked implementation
#[inline]
pub fn add_xonly_tweak<C: Verification>(
mut self,
secp: &Secp256k1<C>,
tweak: &Scalar,
) -> Result<Keypair, Error> {
pub fn add_xonly_tweak(mut self, tweak: &Scalar) -> Result<Keypair, Error> {
// We have no seed here but we want rerandomiziation to happen for `rand` users.
let seed = [0_u8; 32];
unsafe {
let err = ffi::secp256k1_keypair_xonly_tweak_add(
secp.ctx.as_ptr(),
&mut self.0,
tweak.as_c_ptr(),
let err = crate::with_global_context(
|secp: &Secp256k1<crate::AllPreallocated>| {
ffi::secp256k1_keypair_xonly_tweak_add(
secp.ctx.as_ptr(),
&mut self.0,
tweak.as_c_ptr(),
)
},
Some(&seed),
);
if err != 1 {
return Err(Error::InvalidTweak);
Expand Down Expand Up @@ -981,32 +990,40 @@ impl XOnlyPublicKey {
///
/// let mut keypair = Keypair::new(&secp, &mut rand::rng());
/// let (xonly, _parity) = keypair.x_only_public_key();
/// let tweaked = xonly.add_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
/// let tweaked = xonly.add_tweak(&tweak).expect("Improbable to fail with a randomly generated tweak");
/// # }
/// ```
pub fn add_tweak<V: Verification>(
mut self,
secp: &Secp256k1<V>,
tweak: &Scalar,
) -> Result<(XOnlyPublicKey, Parity), Error> {
pub fn add_tweak(mut self, tweak: &Scalar) -> Result<(XOnlyPublicKey, Parity), Error> {
let mut pk_parity = 0;
// We have no seed here but we want rerandomiziation to happen for `rand` users.
let seed = [0_u8; 32];
unsafe {
let mut pubkey = ffi::PublicKey::new();
let mut err = ffi::secp256k1_xonly_pubkey_tweak_add(
secp.ctx.as_ptr(),
&mut pubkey,
self.as_c_ptr(),
tweak.as_c_ptr(),
let mut err = crate::with_global_context(
|secp: &Secp256k1<crate::AllPreallocated>| {
ffi::secp256k1_xonly_pubkey_tweak_add(
secp.ctx.as_ptr(),
&mut pubkey,
self.as_c_ptr(),
tweak.as_c_ptr(),
)
},
Some(&seed),
);
if err != 1 {
return Err(Error::InvalidTweak);
}

err = ffi::secp256k1_xonly_pubkey_from_pubkey(
secp.ctx.as_ptr(),
&mut self.0,
&mut pk_parity,
&pubkey,
err = crate::with_global_context(
|secp: &Secp256k1<crate::AllPreallocated>| {
ffi::secp256k1_xonly_pubkey_from_pubkey(
secp.ctx.as_ptr(),
&mut self.0,
&mut pk_parity,
&pubkey,
)
},
Some(&seed),
);
if err == 0 {
return Err(Error::InvalidPublicKey);
Expand Down Expand Up @@ -1042,25 +1059,31 @@ impl XOnlyPublicKey {
/// let mut keypair = Keypair::new(&secp, &mut rand::rng());
/// let (mut public_key, _) = keypair.x_only_public_key();
/// let original = public_key;
/// let (tweaked, parity) = public_key.add_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
/// assert!(original.tweak_add_check(&secp, &tweaked, parity, tweak));
/// let (tweaked, parity) = public_key.add_tweak(&tweak).expect("Improbable to fail with a randomly generated tweak");
/// assert!(original.tweak_add_check(&tweaked, parity, tweak));
/// # }
/// ```
pub fn tweak_add_check<V: Verification>(
pub fn tweak_add_check(
&self,
secp: &Secp256k1<V>,
tweaked_key: &Self,
tweaked_parity: Parity,
tweak: Scalar,
) -> bool {
let tweaked_ser = tweaked_key.serialize();
// We have no seed here but we want rerandomiziation to happen for `rand` users.
let seed = [0_u8; 32];
unsafe {
let err = ffi::secp256k1_xonly_pubkey_tweak_add_check(
secp.ctx.as_ptr(),
tweaked_ser.as_c_ptr(),
tweaked_parity.to_i32(),
&self.0,
tweak.as_c_ptr(),
let err = crate::with_global_context(
|secp: &Secp256k1<crate::AllPreallocated>| {
ffi::secp256k1_xonly_pubkey_tweak_add_check(
secp.ctx.as_ptr(),
tweaked_ser.as_c_ptr(),
tweaked_parity.to_i32(),
&self.0,
tweak.as_c_ptr(),
)
},
Some(&seed),
);

err == 1
Expand Down Expand Up @@ -1690,8 +1713,6 @@ mod test {
#[test]
#[cfg(feature = "std")]
fn tweak_mul_arbitrary_data() {
let s = Secp256k1::new();

let (sk, pk) = crate::test_random_keypair();
assert_eq!(PublicKey::from_secret_key(&sk), pk); // Sanity check.

Expand All @@ -1700,7 +1721,7 @@ mod test {

let tweaked_sk = sk.mul_tweak(&tweak).unwrap();
assert_ne!(sk, tweaked_sk); // Make sure we did something.
let tweaked_pk = pk.mul_tweak(&s, &tweak).unwrap();
let tweaked_pk = pk.mul_tweak(&tweak).unwrap();
assert_ne!(pk, tweaked_pk);
assert_eq!(PublicKey::from_secret_key(&tweaked_sk), tweaked_pk);
}
Expand Down Expand Up @@ -1925,24 +1946,22 @@ mod test {
#[test]
#[cfg(feature = "std")]
fn test_tweak_add_then_tweak_add_check() {
let s = Secp256k1::new();

for _ in 0..10 {
let tweak = Scalar::test_random();

let kp = Keypair::test_random();
let (xonly, _) = XOnlyPublicKey::from_keypair(&kp);

let tweaked_kp = kp.add_xonly_tweak(&s, &tweak).expect("keypair tweak add failed");
let tweaked_kp = kp.add_xonly_tweak(&tweak).expect("keypair tweak add failed");
let (tweaked_xonly, parity) =
xonly.add_tweak(&s, &tweak).expect("xonly pubkey tweak failed");
xonly.add_tweak(&tweak).expect("xonly pubkey tweak failed");

let (want_tweaked_xonly, tweaked_kp_parity) = XOnlyPublicKey::from_keypair(&tweaked_kp);

assert_eq!(tweaked_xonly, want_tweaked_xonly);
assert_eq!(parity, tweaked_kp_parity);

assert!(xonly.tweak_add_check(&s, &tweaked_xonly, parity, tweak));
assert!(xonly.tweak_add_check(&tweaked_xonly, parity, tweak));
}
}

Expand Down