Struct k256::Secp256k1

source · [−]

pub struct Secp256k1;

Expand description

K-256 (secp256k1) elliptic curve.

Specified in Certicom’s SECG in “SEC 2: Recommended Elliptic Curve Domain Parameters”:

https://www.secg.org/sec2-v2.pdf

The curve’s equation is y² = x³ + 7 over a ~256-bit prime field.

It’s primarily notable for usage in Bitcoin and other cryptocurrencies, particularly in conjunction with the Elliptic Curve Digital Signature Algorithm (ECDSA).

Trait Implementations

source

impl Clone for Secp256k1

source

fn clone(&self) -> Secp256k1

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Compression for Secp256k1

source

const COMPRESS_POINTS: bool

secp256k1 points are typically compressed.

source

impl Curve for Secp256k1

type FieldSize = U32

256-bit (32-byte)

source

impl Debug for Secp256k1

source

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

Formats the value using the given formatter. Read more

source

impl Decompress<Secp256k1> for AffinePoint

source

fn decompress(x_bytes: &FieldBytes, y_is_odd: Choice) -> CtOption<Self>

Attempt to decompress an elliptic curve point

source

impl Default for Secp256k1

source

fn default() -> Secp256k1

Returns the “default value” for a type. Read more

source

impl DigestPrimitive for Secp256k1

type Digest = Sha256

Preferred digest to use when computing ECDSA signatures for this elliptic curve. This should be a member of the SHA-2 family. Read more

source

impl FromDigest<Secp256k1> for Scalar

source

fn from_digest<D>(digest: D) -> Self where
D: Digest<OutputSize = U32>,

Convert the output of a digest algorithm into a Scalar reduced modulo n.

source

impl FromEncodedPoint<Secp256k1> for AffinePoint

source

fn from_encoded_point(encoded_point: &EncodedPoint) -> Option<Self>

Attempts to parse the given EncodedPoint as an SEC1-encoded AffinePoint.

Returns

None value if encoded_point is not on the secp256k1 curve.

source

impl FromEncodedPoint<Secp256k1> for ProjectivePoint

source

fn from_encoded_point(p: &EncodedPoint) -> Option<Self>

Deserialize the type this trait is impl’d on from an EncodedPoint. Read more

source

impl Ord for Secp256k1

source

fn cmp(&self, other: &Secp256k1) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl PartialEq<Secp256k1> for Secp256k1

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PartialOrd<Secp256k1> for Secp256k1

source

fn partial_cmp(&self, other: &Secp256k1) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl ProjectiveArithmetic for Secp256k1

type ProjectivePoint = ProjectivePoint

Elliptic curve point in projective coordinates.

source

impl RecoverableSignPrimitive<Secp256k1> for Scalar

source

fn try_sign_recoverable_prehashed<K>(
 &self,
 ephemeral_scalar: &K,
 z: &Scalar
) -> Result<(Signature, bool ), Error> where
 K: Borrow<Scalar> + Invert<Output = Scalar>,

Try to sign the prehashed message. Read more

source

impl ToEncodedPoint<Secp256k1> for AffinePoint

source

fn to_encoded_point(&self, compress: bool) -> EncodedPoint

Serialize this value as a SEC1 EncodedPoint, optionally applying point compression. Read more

source

impl ToEncodedPoint<Secp256k1> for VerifyingKey

source

fn to_encoded_point(&self, compress: bool) -> EncodedPoint

Serialize this value as a SEC1 EncodedPoint, optionally applying point compression. Read more

source

impl VerifyPrimitive<Secp256k1> for AffinePoint

source

fn verify_prehashed(
 &self,
 z: &Scalar,
 signature: &Signature
) -> Result<(), Error>

Verify the prehashed message against the provided signature Read more

source

impl StructuralPartialEq for Secp256k1

Auto Trait Implementations

impl RefUnwindSafe for Secp256k1

impl Send for Secp256k1

impl Sync for Secp256k1

impl Unpin for Secp256k1

impl UnwindSafe for Secp256k1

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Conv for T

source

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into a target type. Read more

source

impl<T> FmtForward for T

source

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

source

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

source

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

source

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

source

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

source

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

source

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

source

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Pipe for T

source

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

source

impl<T> PipeAsRef for T

source

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: AsRef<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

source

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
 Self: AsMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeBorrow for T

source

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Borrow<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

source

fn pipe_borrow_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: BorrowMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeDeref for T

source

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

source

fn pipe_deref_mut<'a, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
 Self: DerefMut,
 R: 'a,

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeRef for T

source

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

source

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Tap for T

source

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Provides immutable access for inspection. Read more

source

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Calls tap in debug builds, and does nothing in release builds.

source

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Provides mutable access for modification. Read more

source

fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Calls tap_mut in debug builds, and does nothing in release builds.

source

impl<T, U> TapAsRef for T where
U: ?Sized,

source

fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the reference for inspection.

source

fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Calls tap_ref in debug builds, and does nothing in release builds.

source

fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the reference for modification.

source

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_ref_mut in debug builds, and does nothing in release builds.

source

impl<T, U> TapBorrow for T where
U: ?Sized,

source

fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the borrow for inspection. Read more

source

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Calls tap_borrow in debug builds, and does nothing in release builds.

source

fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the borrow for modification.

source

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> TapDeref for T

source

fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Immutably dereferences self for inspection.

source

fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Calls tap_deref in debug builds, and does nothing in release builds.

source

fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Mutably dereferences self for modification.

source

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> TryConv for T

source

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into a target type. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct k256::Secp256k1

Trait Implementations

impl Clone for Secp256k1

fn clone(&self) -> Secp256k1

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

impl Compression for Secp256k1

const COMPRESS_POINTS: bool

impl Curve for Secp256k1

type FieldSize = U32

impl Debug for Secp256k1

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

impl Decompress<Secp256k1> for AffinePoint

fn decompress(x_bytes: &FieldBytes, y_is_odd: Choice) -> CtOption<Self>

impl Default for Secp256k1

fn default() -> Secp256k1

impl DigestPrimitive for Secp256k1

type Digest = Sha256

impl FromDigest<Secp256k1> for Scalar

fn from_digest<D>(digest: D) -> Self where D: Digest<OutputSize = U32>,

impl FromEncodedPoint<Secp256k1> for AffinePoint

fn from_encoded_point(encoded_point: &EncodedPoint) -> Option<Self>

Returns

impl FromEncodedPoint<Secp256k1> for ProjectivePoint

fn from_encoded_point(p: &EncodedPoint) -> Option<Self>

impl Ord for Secp256k1

fn cmp(&self, other: &Secp256k1) -> Ordering

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl PartialEq<Secp256k1> for Secp256k1

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

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

impl PartialOrd<Secp256k1> for Secp256k1

fn partial_cmp(&self, other: &Secp256k1) -> Option<Ordering>

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

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

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

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

impl ProjectiveArithmetic for Secp256k1

type ProjectivePoint = ProjectivePoint

impl RecoverableSignPrimitive<Secp256k1> for Scalar

fn try_sign_recoverable_prehashed<K>( &self, ephemeral_scalar: &K, z: &Scalar) -> Result<(Signature, bool), Error> where K: Borrow<Scalar> + Invert<Output = Scalar>,

impl ToEncodedPoint<Secp256k1> for AffinePoint

fn to_encoded_point(&self, compress: bool) -> EncodedPoint

impl ToEncodedPoint<Secp256k1> for VerifyingKey

fn to_encoded_point(&self, compress: bool) -> EncodedPoint

impl VerifyPrimitive<Secp256k1> for AffinePoint

fn verify_prehashed( &self, z: &Scalar, signature: &Signature) -> Result<(), Error>

impl Curve for Secp256k1

impl Eq for Secp256k1

impl StructuralEq for Secp256k1

impl StructuralPartialEq for Secp256k1

Auto Trait Implementations

impl RefUnwindSafe for Secp256k1

impl Send for Secp256k1

impl Sync for Secp256k1

impl Unpin for Secp256k1

impl UnwindSafe for Secp256k1

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

fn from_digest<D>(digest: D) -> Self where
D: Digest<OutputSize = U32>,

fn try_sign_recoverable_prehashed<K>(
&self,
ephemeral_scalar: &K,
z: &Scalar
) -> Result<(Signature, bool ), Error> where
K: Borrow<Scalar> + Invert<Output = Scalar>,

fn verify_prehashed(
&self,
z: &Scalar,
signature: &Signature
) -> Result<(), Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

impl<T, U> Into<U> for T where
U: From<T>,

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,

fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,

fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

impl<T, U> TapAsRef<U> for T where
U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

impl<T, U> TapBorrow<U> for T where
U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,