Struct secp256k1::Secp256k1

pub struct Secp256k1<C> { /* fields omitted */ }

The secp256k1 engine, used to execute all signature operations

Methods

impl Secp256k1<All>

pub fn new() -> Secp256k1<All>

Creates a new Secp256k1 context with all capabilities

impl Secp256k1<SignOnly>

pub fn signing_only() -> Secp256k1<SignOnly>

Creates a new Secp256k1 context that can only be used for signing

impl Secp256k1<VerifyOnly>

pub fn verification_only() -> Secp256k1<VerifyOnly>

Creates a new Secp256k1 context that can only be used for verification

impl<C> Secp256k1<C>

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

(Re)randomizes the Secp256k1 context for cheap sidechannel resistance; see comment in libsecp256k1 commit d2275795f by Gregory Maxwell. Requires compilation with "rand" feature.

impl<C: Signing> Secp256k1<C>

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

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 ) -> RecoverableSignature

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

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

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. Requires compilation with the "rand" feature.

impl<C: Verification> Secp256k1<C>

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<C> Eq for Secp256k1<C>

impl<C> Drop for Secp256k1<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C> Send for Secp256k1<C>

impl<C> Sync for Secp256k1<C>

impl<C> PartialEq<Secp256k1<C>> for Secp256k1<C>

fn eq(&self, _other: &Secp256k1<C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<C> Clone for Secp256k1<C>

fn clone(&self) -> Secp256k1<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secp256k1<SignOnly>

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

Formats the value using the given formatter.

impl Debug for Secp256k1<VerifyOnly>

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

Formats the value using the given formatter.

impl Debug for Secp256k1<All>

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

Formats the value using the given formatter.