Struct Secp256k1

pub struct Secp256k1 { /* private fields */ }

The secp256k1 engine, used to execute all signature operations

Implementations

impl Secp256k1

pub fn sign_schnorr( &self, msg: &Message, sk: &SecretKey, ) -> Result<Signature, Error>

Create a Schnorr signature

pub fn verify_schnorr( &self, msg: &Message, sig: &Signature, pk: &PublicKey, ) -> Result<(), Error>

Verify a Schnorr signature

pub fn recover_schnorr( &self, msg: &Message, sig: &Signature, ) -> Result<PublicKey, Error>

Retrieves the public key for which sig is a valid signature for msg. Requires a verify-capable context.

impl Secp256k1

pub fn new() -> Secp256k1

Creates a new Secp256k1 context

pub fn with_caps(caps: ContextFlag) -> Secp256k1

Creates a new Secp256k1 context with the specified capabilities

pub fn without_caps() -> Secp256k1

Creates a new Secp256k1 context with no capabilities (just de/serialization)

pub fn randomize<R: Rng>(&mut self, rng: &mut R)

(Re)randomizes the Secp256k1 context for cheap sidechannel resistence; see comment in libsecp256k1 commit d2275795f by Gregory Maxwell

pub fn generate_keypair<R: Rng>( &self, rng: &mut R, ) -> Result<(SecretKey, PublicKey), Error>

Generates a random keypair. Convenience function for key::SecretKey::new and key::PublicKey::from_secret_key; call those functions directly for batch key generation. Requires a signing-capable context.

pub fn sign(&self, msg: &Message, sk: &SecretKey) -> Result<Signature, Error>

Constructs a signature for msg using the secret key sk and RFC6979 nonce Requires a signing-capable context.

pub fn sign_recoverable( &self, msg: &Message, sk: &SecretKey, ) -> Result<RecoverableSignature, Error>

Constructs a signature for msg using the secret key sk and RFC6979 nonce Requires a signing-capable context.

pub fn recover( &self, msg: &Message, sig: &RecoverableSignature, ) -> Result<PublicKey, Error>

Determines the public key for which sig is a valid signature for msg. Requires a verify-capable context.

pub fn verify( &self, msg: &Message, sig: &Signature, pk: &PublicKey, ) -> Result<(), Error>

Checks that sig is a valid ECDSA signature for msg using the public key pubkey. Returns Ok(true) on success. Note that this function cannot be used for Bitcoin consensus checking since there may exist signatures which OpenSSL would verify but not libsecp256k1, or vice-versa. Requires a verify-capable context.

Trait Implementations

impl Clone for Secp256k1

fn clone(&self) -> Secp256k1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secp256k1

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

Formats the value using the given formatter.

impl Drop for Secp256k1

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Secp256k1

fn eq(&self, other: &Secp256k1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Secp256k1

impl Send for Secp256k1

impl Sync for Secp256k1