Skip to main content

Secp256k1

Struct Secp256k1 

Source
pub struct Secp256k1 { /* private fields */ }
Expand description

Secp256k1 - a short Weierstrass elliptic curve of the form y^2 = x^3 + 7 over the prime field of modulus 2^256 - 2^32 - 977.

Implementations§

Source§

impl Secp256k1

Source

pub fn new(b: &CircuitBuilder) -> Self

Creates new curve struct with constants related to curve and its coordinate and scalar fields.

Source

pub const fn f_p(&self) -> &PseudoMersennePrimeField

Coordinate field.

Source

pub const fn f_scalar(&self) -> &PseudoMersennePrimeField

Scalar field.

Source

pub fn assert_on_curve(&self, b: &CircuitBuilder, p: &Secp256k1Affine)

Assert that given affine point actually resides on curve.

Considers point-at-infinity not on curve.

Source

pub fn recover( &self, b: &CircuitBuilder, r: &BigUint, recid_odd: Wire, ) -> Secp256k1Affine

Recover the full affine point (r, y) by its x coordinate and y parity. Returns point-at-infinity in case recovery isn’t possible.

Note: we don’t handle the case where r does not fit into the scalar field, thus recid is boolean, and not a 0-3 bitmask signifying both parity and scalar field overflow.

Source

pub fn negate_if( &self, b: &CircuitBuilder, cond: Wire, p: &Secp256k1Affine, ) -> Secp256k1Affine

Negate the curve point p if MSB-bool cond is true.

Source

pub fn endomorphism( &self, b: &CircuitBuilder, p: &Secp256k1Affine, ) -> Secp256k1Affine

Compute the endomorphism λ (x, y) = (βx, y).

Source

pub fn add( &self, b: &CircuitBuilder, p1: &Secp256k1Affine, p2: &Secp256k1Affine, ) -> Secp256k1Affine

Add two curve points.

Requires both p1 and p2 to be either valid curve points or points at infinities.

This implementation is complete - it handles the cases of either p1 or p2 being point-at-infinities, as well as being equal (which falls back to doubling).

Source

pub fn add_incomplete( &self, b: &CircuitBuilder, p1: &Secp256k1Affine, p2: &Secp256k1Affine, ) -> Secp256k1Affine

Add two curve points, incomplete.

Requires both p1 and p2 to be either valid curve points or points at infinities.

Unlike Secp256k1::add this implementation does not handle doubling, asserting false in that case.

Source

pub fn double(&self, b: &CircuitBuilder, p: &Secp256k1Affine) -> Secp256k1Affine

Double a curve point.

Requires both p to be either a valid curve point or point at infinity.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more